[project @ 1999-06-16 09:48:00 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        } elsif ($BuildTag eq '_u' && $GhcWithRegisterised eq 'NO') {
943          $HiSuffix_prelude = 'hi';
944        } else {
945          local($Tag) = "${BuildTag}";
946   
947          $Tag =~ s/_//;
948          $Tag =  "${Tag}_" if $Tag ne '';
949          $HiSuffix_prelude="${Tag}hi";
950        }
951   }
952 } # setupBuildFlags
953 \end{code}
954
955 %************************************************************************
956 %*                                                                      *
957 \subsection{Add on machine-specific C-compiler flags}
958 %*                                                                      *
959 %************************************************************************
960
961 Shove on magical machine-specific options.  We use \tr{unshift} to
962 stick them on the {\em front} of the arrays, so that ``later''
963 user-specified flags can clobber them (e.g., \tr{-U__STG_REV_TBLS__}).
964
965 Note: a few ``always apply'' flags were set at the very beginning.
966
967 \begin{code}
968 sub setupMachOpts {
969
970   if ($TargetPlatform =~ /^alpha-/) {
971       unshift(@CcBoth_flags,  ('-static'));
972
973   } elsif ($TargetPlatform =~ /^hppa/) {
974       unshift(@CcBoth_flags,  ('-static'));
975       #
976       # We don't put in '-mlong-calls', because it's only
977       # needed for very big modules (sigh), and we don't want
978       # to hobble ourselves further on all the other modules
979       # (most of them).
980       #  
981       # [Dated comment (gcc-2.6.x?), -mlong-calls is no longer
982       #  a supported gcc HPPA flag]
983       unshift(@CcBoth_flags,  ('-D_HPUX_SOURCE'));
984         # ___HPUX_SOURCE, not _HPUX_SOURCE, is #defined if -ansi!
985         # (very nice, but too bad the HP /usr/include files don't agree.)
986
987   } elsif ($TargetPlatform =~ /^i386-/) {
988       # -fno-defer-pop : basically the same game as for m68k
989       #
990       # -fomit-frame-pointer : *must* in .hc files; because we're stealing
991       #  the fp (%ebp) for our register maps.
992
993       unshift(@CcRegd_flags_hc, '-fno-defer-pop');
994       unshift(@CcRegd_flags_hc, '-fomit-frame-pointer');
995       unshift(@CcRegd_flags,    "-DSTOLEN_X86_REGS=$StolenX86Regs");
996       
997       unshift(@CcBoth_flags,  ('-DDONT_WANT_WIN32_DLL_SUPPORT')) if ($Static);
998
999   } elsif ($TargetPlatform =~ /^m68k-/) {
1000       # -fno-defer-pop : for the .hc files, we want all the pushing/
1001       #    popping of args to routines to be explicit; if we let things
1002       #    be deferred 'til after an STGJUMP, imminent death is certain!
1003       #
1004       # -fomit-frame-pointer : *don't*
1005       #    It's better to have a6 completely tied up being a frame pointer
1006       #    rather than let GCC pick random things to do with it.
1007       #    (If we want to steal a6, then we would try to do things
1008       #    as on iX86, where we *do* steal the frame pointer [%ebp].)
1009
1010       unshift(@CcRegd_flags_hc, '-fno-defer-pop');
1011       unshift(@CcRegd_flags,    '-fno-omit-frame-pointer');
1012         # maybe gives reg alloc a better time
1013         # also: -fno-defer-pop is not sufficiently well-behaved without it
1014
1015   } elsif ($TargetPlatform =~ /^mips-/) {
1016       unshift(@CcBoth_flags,  ('-static'));
1017
1018   } elsif ($TargetPlatform =~ /^powerpc-|^rs6000-/) {
1019       unshift(@CcBoth_flags,  ('-static')); # always easier to start with
1020       unshift(@CcRegd_flags, ('-finhibit-size-directive')); # avoids traceback tables
1021   } elsif ($TargetPlatform =~ /^sparc-/) {
1022   }
1023 } # end of setupMachOpts
1024 \end{code}
1025
1026 %************************************************************************
1027 %*                                                                      *
1028 \subsection{Set up for warnings}
1029 %*                                                                      *
1030 %************************************************************************
1031
1032 Several warnings are turned on by default.  These are supposed to be
1033 the 'I'm pretty sure you've made a mistake here' kind of warnings.
1034 The rest are turned on by the -W and -Wall options, or individually
1035 via their -fwarn and -fno-warn flags.
1036
1037 \begin{code}
1038 sub setupWarningFlags {
1039 &add_Hsc_flags( @StandardWarnings );
1040 }
1041 \end{code}
1042
1043 Same unshifting magic, but for special linker flags.
1044
1045 The configure script determines whether the object file symbol tables
1046 have a leading underscore, and sets @LeadingUnderscore@ accordingly.
1047 (The driver script `sees' the setting of the @LeadingUnderscore@
1048 by having the Makefile prepend it).
1049
1050 \begin{code}
1051 sub setupLinkOpts {
1052   local($uscore) = ( ${LeadingUnderscore} eq 'YES' ) ? '_' : '';
1053
1054   unshift(@Ld_flags,
1055         (($Ld_main) ? ( '-u', "${uscore}Main_" . $Ld_main . '_closure' ) : ()));
1056
1057   # things that are referenced by the RTS - make sure that we pull 'em in
1058   unshift(@Ld_flags,
1059          ( '-u', "${uscore}PrelBase_Izh_static_info"
1060           ,'-u', "${uscore}PrelBase_Czh_static_info"
1061           ,'-u', "${uscore}PrelBase_Fzh_static_info"
1062           ,'-u', "${uscore}PrelBase_Dzh_static_info"
1063           ,'-u', "${uscore}PrelAddr_Azh_static_info"
1064           ,'-u', "${uscore}PrelAddr_Wzh_static_info"
1065           ,'-u', "${uscore}PrelAddr_I64zh_static_info"
1066           ,'-u', "${uscore}PrelAddr_W64zh_static_info"
1067           ,'-u', "${uscore}PrelStable_StablePtr_static_info"
1068           ,'-u', "${uscore}PrelBase_Izh_con_info"
1069           ,'-u', "${uscore}PrelBase_Czh_con_info"
1070           ,'-u', "${uscore}PrelBase_Fzh_con_info"
1071           ,'-u', "${uscore}PrelBase_Dzh_con_info"
1072           ,'-u', "${uscore}PrelAddr_Azh_con_info"
1073           ,'-u', "${uscore}PrelAddr_Wzh_con_info"
1074           ,'-u', "${uscore}PrelAddr_I64zh_con_info"
1075           ,'-u', "${uscore}PrelAddr_W64zh_con_info"
1076           ,'-u', "${uscore}PrelStable_StablePtr_con_info"
1077           ,'-u', "${uscore}PrelBase_False_static_closure"
1078           ,'-u', "${uscore}PrelBase_True_static_closure"
1079           ,'-u', "${uscore}PrelPack_unpackCString_closure"
1080           ,'-u', "${uscore}PrelException_stackOverflow_closure"
1081           ,'-u', "${uscore}PrelException_heapOverflow_closure"
1082         ));
1083   if (!$NoHaskellMain) {
1084    unshift (@Ld_flags,'-u', "${uscore}PrelMain_mainIO_closure");
1085   }
1086   if ($TargetPlatform =~ /^powerpc-|^rs6000-/) {
1087     # sometimes we have lots of toc entries...
1088     #  unshift(@Ld_flags, ('-Xlinker -bbigtoc -Xlinker -bnoquiet')); 
1089     unshift(@Ld_flags, ('-Xlinker -bbigtoc')); 
1090   }
1091
1092
1093 } # end of setupLinkOpts
1094
1095 \end{code}
1096
1097 %************************************************************************
1098 %*                                                                      *
1099 \subsection{Set up include paths and system-library enslurpment}
1100 %*                                                                      *
1101 %************************************************************************
1102
1103 Now that we know what garbage-collector, etc., are required, we can
1104 finalise our list of libraries to slurp through, and generally Get
1105 Ready for Business.
1106
1107 \begin{code}
1108 sub setupIncPaths {
1109   # default includes must be added AFTER option processing
1110   if ( ! $INSTALLING ) {
1111       push (@Include_dir, "$TopPwd/${CURRENT_DIR}/${GHC_INCLUDE_DIR}");
1112   } else {
1113       push (@Include_dir, "$InstLibDirGhc/includes");
1114       push (@Include_dir, "$InstLibDirGhc/includes");
1115   }
1116 } # end of setupIncPaths
1117 \end{code}
1118
1119 \begin{code}
1120 sub setupSyslibs {
1121   push(@SysLibrary, ( '-lHS', '-lHS_cbits' )); # basic I/O and prelude stuff
1122
1123   local($f);
1124   foreach $f (@SysLibrary) {
1125       next if $f =~ /_cbits/;
1126       $f .= $BuildTag if $f =~ /^-lHS/;
1127   }
1128
1129   # Push library HSrts, plus boring clib bit
1130   push(@SysLibrary, "-lHSrts${BuildTag}");
1131
1132   #
1133   # RTS compiled with cygwin32, uses the WinMM API
1134   # to implement the itimers, since cygwin.dll does not
1135   # support it. Only reqd. for `ways' that use itimers.
1136   #
1137   push(@SysLibrary, '-lwinmm')   if $TargetPlatform eq 'i386-unknown-cygwin32';
1138    # Note: currently only tested with mingw, may cause conflicts when linking
1139    #       with libcygwin.a
1140   push(@SysLibrary, '-lwsock32') if ($TargetPlatform =~ /-(mingw32|cygwin32)$/);
1141
1142   # Push the pvm libraries
1143   if ($BuildTag eq '_mp') {
1144       $pvmlib = "$ENV{'PVM_ROOT'}/lib/$ENV{'PVM_ARCH'}";
1145       push(@SysLibrary, "-L$pvmlib", '-lgpvm3', '-lpvm3');
1146       if ( $ENV{'PVM_ARCH'} eq 'SUNMP' ) {
1147           push(@SysLibrary, '-lthread', '-lsocket', '-lnsl');
1148       } elsif ( $ENV{'PVM_ARCH'} eq 'SUN4SOL2' ) {
1149           push(@SysLibrary, '-lsocket', '-lnsl');
1150       }
1151   }
1152
1153 # Push the GNU multi-precision arith lib; and the math library
1154
1155 # If this machine has GMP already installed, then we'll get the installed
1156 # lib here, because presumably the one in the tree won't have been built.
1157
1158 if ($LibGmp eq 'not-installed') {
1159   push(@SysLibrary, "-lgmp");
1160 } else {
1161   push(@SysLibrary, "-l$LibGmp");
1162 }
1163
1164 push(@SysLibrary, '-lm') if !( $TargetPlatform =~ /^.*(cygwin32|mingw32)$/ );
1165 \end{code}
1166
1167 %************************************************************************
1168 %*                                                                      *
1169 \subsection{Check that this system was built to do what we are asking}
1170 %*                                                                      *
1171 %************************************************************************
1172
1173 Before continuing we check that the appropriate build is available.
1174
1175 \begin{code}
1176 #die "$Pgm: no BuildAvail?? $BuildTag\n" if $BuildDescr{$BuildTag} eq '' ; # sanity
1177
1178 if ( $BuildDescr{$BuildTag} eq '' ) {
1179     print STDERR "$Pgm: a `", $BuildDescr{$BuildTag},
1180         "' \"build\" is not available with your GHC setup.\n";
1181     print STDERR "(It was not configured for it at your site.)\n";
1182     print STDERR $ShortUsage;
1183     exit 1;
1184 }
1185
1186 } # end of setupSyslibs
1187
1188 \end{code}
1189
1190 %************************************************************************
1191 %*                                                                      *
1192 \subsection{Final miscellaneous setup bits before we start going}
1193 %*                                                                      *
1194 %************************************************************************
1195
1196 Record largest specific heapsize, if any.
1197 \begin{code}
1198 sub setupHeapStackSize {
1199    $Specific_heap_size = $Specific_heap_size * $Scale_sizes_by;
1200    push(@HsC_rts_flags, '-H'.$Specific_heap_size);
1201    $Specific_stk_size = $Specific_stk_size * $Scale_sizes_by;
1202    push(@HsC_rts_flags, "-K$Specific_stk_size");
1203 }
1204 \end{code}
1205
1206 If no input or link files seen, then we let 'em feed in stdin; this is
1207 mainly for debugging.
1208
1209 \begin{code}
1210
1211 if ($#Input_file < 0 && $#Link_file < 0) {
1212     @Input_file = ( '-' );
1213
1214     open(INF, "> $Tmp_prefix.hs") || &tidy_up_and_die(1,"Can't open $Tmp_prefix.hs\n");
1215     print STDERR "Enter your Haskell program, end with ^D (on a line of its own):\n" if -t;
1216     while (<STDIN>) { print INF $_; }
1217     close(INF) || &tidy_up_and_die(1,"Failed writing to $Tmp_prefix.hs\n");
1218 }
1219
1220 \end{code}
1221
1222 Tell the world who we are, if they asked.
1223 \begin{code}
1224 print STDERR "${ProjectName}, version ${ProjectVersion}, patchlevel ${ProjectPatchLevel}\n"
1225     if $Verbose;
1226 \end{code}
1227
1228 %************************************************************************
1229 %*                                                                      *
1230 \section[Driver-main-loop]{Main loop: Process input files, and link if required}
1231 %*                                                                      *
1232 %************************************************************************
1233
1234 Process the input files; don't continue with linking if there are
1235 problems (global variable @$Status@ non-zero).
1236 \begin{code}
1237 foreach $ifile (@Input_file) {
1238     &ProcessInputFile($ifile);
1239 }
1240
1241 # don't link if there were errors...
1242 if ( $Status > 0 ) { 
1243     print STDERR $ShortUsage;
1244     &tidy_up();
1245     exit $Status;
1246 }
1247
1248 # Link if appropriate.
1249 &runLinker() if $Do_lnkr;
1250
1251 # that...  that's all, folks!
1252 &tidy_up();
1253 exit $Status; # will still be 0 if all went well
1254 \end{code}
1255
1256 %************************************************************************
1257 %*                                                                      *
1258 \section[Driver-do-one-file]{How to process a single input file}
1259 %*                                                                      *
1260 %************************************************************************
1261
1262 \begin{code}
1263 sub ProcessInputFile {
1264     local($ifile) = @_;   # input file name
1265     local($ifile_root);   # root of or basename of input file
1266     local($ofile_target); # ultimate output file we hope to produce
1267                           # from input file (need to know for recomp
1268                           # checking purposes)
1269     local($hifile_target);# ditto (but .hi file)
1270     local($ofile_c_stub_target); 
1271     local($ofile_h_stub_target); 
1272 \end{code}
1273
1274 Handle the weirdity of input from stdin.
1275 \begin{code}
1276     if ($ifile ne '-') {
1277         ($ifile_root  = $ifile) =~ s/\.[^\.\/]+$//;
1278         $ofile_target = # may be reset later...
1279                         ($Specific_output_file ne '' && ! $Do_lnkr)
1280                         ? $Specific_output_file
1281                         : &odir_ify($ifile_root, 'o');
1282         $hifile_target= ($Specific_hi_file ne '')
1283                         ? $Specific_hi_file
1284                         : "$ifile_root.$HiSuffix"; # ToDo: odirify?
1285                         # NB: may change if $ifile_root isn't module name (??)
1286         ($ofile_c_stub_target = $ifile) =~s/\.[^\.\/]+$/_stub.c/;
1287         ($ofile_h_stub_target = $ifile) =~s/\.[^\.\/]+$/_stub.h/;
1288     } else {
1289         $ifile = "$Tmp_prefix.hs"; # we know that's where we put the input
1290         $ifile_root   = '_stdin';
1291         $ofile_target = '_stdout'; # gratuitous?
1292         $hifile_target= '_stdout'; # ditto?
1293     }
1294 \end{code}
1295
1296 We need to decide what phases of the compilation system we will run
1297 over this file.  The defaults are the ones established when processing
1298 flags.  (That established what the last phase run for all files is.)
1299
1300 We do the pre-recompilation-checker phases here; the rest later.
1301 \begin{code}
1302 \end{code}
1303
1304 Look at the suffix and decide what initial phases of compilation may
1305 be dropped off for this file.  Also the rather boring business of
1306 which files are coming-in/going-out.
1307
1308 Again, we'll do the post-recompilation-checker parts of this later.
1309 \begin{code}
1310     local($do_lit2pgm)  = ($ifile =~ /\.lhs$/) ? 1 : 0;
1311     local($do_hscpp)    = 1; # but "hscpp" might really be "cat"
1312     local($do_hsc)      = 1;
1313
1314     # names of the files to stuff between phases
1315     # defaults are temporaries
1316     local($in_lit2pgm)    = $ifile;
1317     local($lit2pgm_hscpp) = "$Tmp_prefix.lpp";
1318     local($hscpp_hsc)     = "$Tmp_prefix.cpp";
1319     local($hsc_hi)        = "$Tmp_prefix.hi";
1320     local($cc_as_o)       = "${Tmp_prefix}_o.s"; # temporary for raw .s file if opt C
1321     local($cc_as)         = "$Tmp_prefix.s";     # mangled or hsc-produced .s code
1322     local($as_out)        = $ofile_target;
1323
1324     local($is_hc_file) = 1; #Is the C code .hc or .c? Assume .hc for now
1325
1326     # OK, let's strip off some literate junk..
1327     if ($do_lit2pgm) {
1328         &runLit2pgm($in_lit2pgm, $lit2pgm_hscpp)
1329     } else {
1330         $lit2pgm_hscpp = $ifile;
1331     }
1332
1333     #
1334     @File_options = ();
1335
1336     # Scan the top of the de-litted file for {-# OPTIONS #-} pragmas
1337     &check_for_source_options($lit2pgm_hscpp,$ifile);
1338
1339     # Options found in the source file take a back seat, i.e., we scan
1340     # them first. Only process the command line again if source file
1341     # contained anything of interest *or* there's more than one
1342     # input file (we have to reset the options).
1343     #
1344     if ( $#Input_file >= 0 || $#File_options >= 0) {
1345         #@File_options = (@File_options, @Cmd_opts);
1346
1347         # Now process the command line
1348         &initDriverGlobals();
1349         &processArgs((@File_options,@Cmd_opts));
1350         print STDERR "\nEffective command line: " .
1351                      join(' ',(@File_options,@Cmd_opts)) . "\n" if $Verbose;
1352     }
1353     #
1354     # Having got the effective command line scanned, set up
1355     # the various options in prep for some real work.
1356     #
1357     # check the sanity of the BuildTag we're about to use,
1358     # and if needs be, add some more flags and setup to
1359     # the different phases.
1360     #
1361     &setupBuildFlags();
1362     &setupOptimiseFlags();
1363     &setupMachOpts();
1364     &setupIncPaths();
1365     &setupWarningFlags();
1366     &setupHeapStackSize();
1367
1368     #
1369     # These two variables need to be set after the
1370     # command-line has been processed and the build options
1371     # have be seen set up. This is because command-line options
1372     # can control whether to compile vias C or not.
1373     # 
1374     local($do_cc)       = ( $Do_cc != -1) # i.e., it was set explicitly
1375                           ? $Do_cc
1376                           : ( ($HscOut eq '-C=') ? 1 : 0 );
1377     local($do_as)       = $Do_as;
1378     local($hsc_out)        = ( $HscOut eq '-C=' ) ? "$Tmp_prefix.hc" : "$Tmp_prefix.s" ;
1379     local($hsc_out_c_stub) = ( $HscOut eq '-C=' ) ? "${Tmp_prefix}_stb.c" : "";
1380     local($hsc_out_h_stub) = ( $HscOut eq '-C=' ) ? "${Tmp_prefix}_stb.h" : "";
1381
1382     if ($Only_preprocess_hc) { # stop after having run $Cc -E
1383        $do_as=0;
1384     }
1385     if ($Only_preprocess_C)     { # stop after having run $hscpp
1386        $do_hsc=0; $do_cc = 0; $do_as=0;
1387     } elsif ($ifile =~ /.lhs$/ || $ifile =~ /.hs$/ ) {
1388        ;
1389     } elsif ($ifile =~ /\.hc$/ || $ifile =~ /_hc$/ ) { # || $ifile =~ /\.$Isuffix$/o) # ToDo: better
1390         $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
1391         $hsc_out = $ifile;
1392         $hsc_out_c_stub = '';
1393         $hsc_out_h_stub = '';
1394     } elsif ($ifile =~ /\.c$/) {
1395         $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
1396         $hsc_out = $ifile; $is_hc_file = 0;
1397         $hsc_out_c_stub = '';
1398         $hsc_out_h_stub = '';
1399     } elsif ($ifile =~ /\.[sS]$/) {
1400         $do_hscpp = 0; $do_hsc = 0; $do_cc = 0;
1401         $cc_as = $ifile;    
1402     } else { # don't know what it is, but nothing to do herein...
1403         $do_hscpp = 0; $do_hsc = 0; $do_cc = 0; $do_as = 0;
1404     }
1405
1406     # hack to avoid running hscpp
1407     $HsCpp = $Cat if ! $Cpp_flag_set;
1408
1409     &runHscpp($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc) if $do_hscpp;
1410
1411 \end{code}
1412
1413 We now think about whether to run hsc/cc or not (when hsc produces .s
1414 stuff, it effectively takes the place of both phases).
1415 To get the output file name right: for each phase that we are {\em
1416 not} going to run, set its input (i.e., the output of its preceding
1417 phase) to @"$ifile_root.<suffix>"@.
1418
1419 \begin{code}
1420     local($going_interactive) = $HscOut eq '-N=' || $ifile_root eq '_stdin';
1421
1422     #
1423     # Warning issued if -keep-hc-file-too is used without
1424     # -fvia-C (or the equivalent)
1425     #
1426     if ( $HscOut ne '-C=' && $Keep_hc_file_too ) {
1427         print STDERR "$Pgm: warning: Native code generator to be used, -keep-hc-file-too will be ignored\n";
1428     }
1429
1430     if (! $do_cc && ! $do_as) { # stopping after hsc
1431         $hsc_out = ($Specific_output_file ne '')
1432                  ? $Specific_output_file
1433                  : &odir_ify($ifile_root, ($HscOut eq '-C=') ? 'hc' : 's');
1434
1435         $ofile_target = $hsc_out; # reset
1436     }
1437
1438     if (! $do_as) { # stopping after gcc (or hsc)
1439         $cc_as = ($Specific_output_file ne '')
1440                  ? $Specific_output_file
1441                  : &odir_ify($ifile_root, ( $Only_preprocess_hc ) ? 'i' : 's');
1442
1443         $ofile_target = $cc_as; # reset
1444     }
1445
1446 \end{code}
1447
1448
1449 Now the Haskell compiler, C compiler, and assembler
1450
1451 \begin{code}
1452    if ($do_hsc) {
1453         &runHscAndProcessInterfaces( $ifile, $hscpp_hsc, $ifile_root, 
1454                                      $ofile_target, $hifile_target,
1455                                      $going_interactive);
1456     }
1457
1458     if (-f $hsc_out_h_stub) {
1459         &run_something("cp $hsc_out_h_stub $ofile_h_stub_target", 'Copy foreign export header file');
1460     }
1461
1462     if (-f $hsc_out_c_stub) {
1463         &run_something("cp $hsc_out_c_stub $ofile_c_stub_target", 'Copy foreign export C stubs');
1464         local ($hsc_out_s_stub);
1465         local ($hsc_out_o_stub);
1466         ($ofile_s_stub_target = $ofile_c_stub_target) =~ s/\.(.*)$/\.s/;
1467         ($ofile_o_stub_target = $ofile_c_stub_target) =~ s/\.(.*)$/\.o/;
1468         &runGcc    (0, $ofile_c_stub_target, $ofile_s_stub_target);
1469         &runAs     ($ofile_o_stub_target, $ofile_s_stub_target);
1470         #
1471         # Bring the C stub protos into scope when compiling the .hc file.
1472         #
1473         push (@CcInjects, "#include \"${hsc_out_h_stub}\"\n");
1474         # Hack - ensure that the stub .h file is included in the OPTIONS section
1475         #        if the .hc file is saved.
1476         push (@File_options, "-#include \"${ofile_h_stub_target}\"\n");
1477         
1478     }
1479
1480     if ($do_cc) {
1481         &runGcc    ($is_hc_file, $hsc_out, $cc_as_o);
1482         &runMangler($is_hc_file, $cc_as_o, $cc_as, $ifile_root) if ! $Only_preprocess_hc;
1483     }
1484
1485     &split_asm_file($cc_as)  if $do_as && $SplitObjFiles;
1486
1487     # save a copy of the .s file..
1488     &saveIntermediate($ifile_root , "s" , $cc_as) if ($do_as && $Keep_s_file_too);
1489     &runAs($as_out, $ifile_root) if $do_as;
1490 \end{code}
1491
1492 Finally, decide what to queue up for linker input.
1493 \begin{code}
1494     # tentatively assume we will eventually produce linker input:
1495     push(@Link_file, &odir_ify($ifile_root, 'o'));
1496
1497 #ToDo:    local($or_isuf) = ($Isuffix eq '') ? '' : "|$Isuffix";
1498
1499     if ( $ifile !~ /\.(lhs|hs|hc|c|s|a|S)$/ && $ifile !~ /_hc$/ ) {
1500         # There's sometimes confusion regarding .hi files; users
1501         # supplying them on the command line.
1502         if ( $ifile =~ /\.hi$/ ) {
1503             print STDERR "$Pgm: warning: found `$ifile' on command line; interface files should not be supplied here - ignoring it.\n";
1504         } else {
1505            print STDERR "$Pgm: don't recognise suffix on `$ifile'; passing it through to linker\n";
1506         }
1507         # oops; we tentatively pushed the wrong thing; fix & do the right thing
1508         pop(@Link_file); push(@Link_file, $ifile);
1509     }
1510
1511
1512 } # end of ProcessInputFile
1513 \end{code}
1514
1515 %************************************************************************
1516 %*                                                                      *
1517 \section[Driver-run-phases]{Routines to run the various phases}
1518 %*                                                                      *
1519 %************************************************************************
1520
1521 \begin{code}
1522 sub runLit2pgm {
1523     local($in_lit2pgm, $lit2pgm_hscpp) = @_;
1524
1525     local($to_do) = "";
1526
1527     # Only add #line pragma if we're going to need it.
1528     $to_do  = "echo '#line 1 \"$in_lit2pgm\"' > $lit2pgm_hscpp && " if ($Cpp_flag_set);
1529     $to_do .= "$Unlit @Unlit_flags $in_lit2pgm -  >> $lit2pgm_hscpp";
1530      
1531     push(@Files_to_tidy, $lit2pgm_hscpp );
1532
1533     &run_something($to_do, 'literate pre-processor');
1534 }
1535 \end{code}
1536
1537 \begin{code}
1538 sub runHscpp {
1539     local($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc) = @_;
1540
1541     local($to_do) = "";
1542
1543     # Strictly speaking, echoing of the following line pragma is only required
1544     # on non-delit'ed input, as we've already added it during de-lit. However,
1545     # hscpp will then add a {-# LINE 1 "$lit2pgm_hsc" -} to the top of the file,
1546     # which is not very informative (but harmless). Hence, we uniformly have
1547     # {-# LINE 1 "$in_lit2pgm" #-} as the first line to all cpp'ed hsc input.
1548     #
1549     $to_do = "echo '{-# LINE 1 \"$in_lit2pgm\" -}' > $hscpp_hsc && ";
1550
1551     if ($HsCpp eq $Cat) {
1552         $to_do .= "$HsCpp $lit2pgm_hscpp >> $hscpp_hsc";
1553         push(@Files_to_tidy, $hscpp_hsc );
1554         &run_something($to_do, 'Ineffective C pre-processor');
1555     } else {
1556         local($includes) = '-I' . join(' -I',@Include_dir);
1557         $to_do .= "$HsCpp $Verbose @HsCpp_flags @HsSourceCppOpts $includes $lit2pgm_hscpp >> $hscpp_hsc";
1558         push(@Files_to_tidy, $hscpp_hsc );
1559         &run_something($to_do, 'Haskellised C pre-processor');
1560     }
1561    
1562     if ( $Only_preprocess_C ) {
1563         $to_do = "$Cat $hscpp_hsc";
1564         &run_something($to_do, '');
1565     }
1566
1567 }
1568 \end{code}
1569
1570
1571 \begin{code}
1572 sub runHscAndProcessInterfaces {
1573     local($ifile, $hscpp_hsc, $ifile_root, 
1574           $ofile_target, $hifile_target,
1575           $going_interactive) = @_;
1576
1577         # $ifile                is the original input file
1578         # $hscpp_hsc            post-unlit, post-cpp, etc., input file
1579         # $ifile_root           input filename minus suffix
1580         # $ofile_target         the output file that we ultimately hope to produce
1581         # $hifile_target        the .hi file ... (ditto)
1582         
1583     local($source_unchanged) = 1;
1584
1585     # Check if the source file is up to date relative to the target; in
1586     # that case we say "source is unchanged" and let the compiler bail out
1587     # early if the import usage information allows it.
1588
1589     ($i_dev,$i_ino,$i_mode,$i_nlink,$i_uid,$i_gid,$i_rdev,$i_size,
1590      $i_atime,$i_mtime,$i_ctime,$i_blksize,$i_blocks) = stat($ifile);
1591
1592     # The informational messages below are now conditional on -v being set -- SOF
1593     if ( $ofile_target ne "_stdin.s" && ! -f $ofile_target ) {
1594         print STDERR "$Pgm:compile:Output file $ofile_target doesn't exist\n" if $Verbose;
1595         $source_unchanged = 0;
1596     }
1597
1598     ($o_dev,$o_ino,$o_mode,$o_nlink,$o_uid,$o_gid,$o_rdev,$o_size,
1599      $o_atime,$o_mtime,$o_ctime,$o_blksize,$o_blocks) = stat(_); # stat info from -f test
1600
1601     if ( $hifile_target ne "_stdout" && ! -f $hifile_target ) {
1602         print STDERR "$Pgm:compile:Interface file $hifile_target doesn't exist\n" if $Verbose;
1603         $source_unchanged = 0;
1604     }
1605
1606     ($hi_dev,$hi_ino,$hi_mode,$hi_nlink,$hi_uid,$hi_gid,$hi_rdev,$hi_size,
1607      $hi_atime,$hi_mtime,$hi_ctime,$hi_blksize,$hi_blocks) = stat(_); # stat info from -f test
1608
1609     if ( $ofile_target ne "_stdin.s" && $i_mtime > $o_mtime) {
1610         print STDERR "$Pgm:recompile:Input file $ifile newer than $ofile_target\n" if $Verbose;
1611         $source_unchanged = 0;
1612     }
1613
1614     # Tell the compiler which version we're using
1615     push(@HsC_flags, "-fhi-version=${ProjectVersionInt}");
1616
1617     # So if source_unchanged is still "1", we pass on the good news to the compiler
1618     # The -recomp flag can disable this, forcing recompilation
1619     if ($Do_recomp_chkr && $source_unchanged) {
1620         push(@HsC_flags, '-fsource-unchanged'); 
1621     }   
1622
1623     # Indicate whether we're static or not.
1624     # This will only ever 
1625     push(@HsC_flags, '-static') if $Static;
1626
1627     # Run the compiler
1628
1629     &runHsc($ifile_root, $hsc_out, $hsc_hi, $hsc_out_c_stub, $hsc_out_h_stub, $going_interactive);
1630
1631    # See if it bailed out early, saying nothing needed doing.  
1632    # We work this out by seeing if it created an output .hi file
1633
1634     if ( ! -f $hsc_hi && $ProduceHi !~ /-nohifile=/ ) {
1635         # Doesn't exist, so we bailed out early.
1636         # Tell the C compiler and assembler not to run
1637         $do_cc = 0; $do_as = 0;
1638
1639         # Update dependency info, touch both object file and 
1640         # interface file, so that the following invariant is
1641         # maintained:
1642         #
1643         #   a dependent module's interface file should after recompilation
1644         #   checking be newer than the interface files of its imports. 
1645         #
1646         # That is, if module A's interface file changes, then module B
1647         # (which import from A) needs to be checked.
1648         # If A's change does not affect B, which causes the compiler to bail
1649         # out early, we still need to touch the interface file of B. The reason
1650         # for this is that B may export A's interface.
1651         #
1652         &run_something("touch $ofile_target",
1653                        "Touch $ofile_target,  to propagate dependencies") if $HscOut ne '-N=';
1654         &run_something("touch $hifile_target", 
1655                        "Touch $hifile_target,  to propagate dependencies") if $ProduceHi =~ /-nohifile=/ ;
1656
1657     } else {    
1658
1659      # Didn't bail out early (new .hi file) so we thunder on
1660     
1661         # If non-interactive, heave in the consistency info at the end
1662         # NB: pretty hackish (depends on how $output is set)
1663         if ( ! $going_interactive ) {
1664             if ( $HscOut eq '-C=' ) {
1665             $to_do = "echo 'static char ghc_hsc_ID[] = \"\@(#)hsc $ifile\t$HsC_major_version.$HsC_minor_version,$HsC_consist_options\";' >> $hsc_out";
1666     
1667             } elsif ( $HscOut eq '-S=' ) {
1668                 local($consist) = "hsc.$ifile.$HsC_major_version.$HsC_minor_version.$HsC_consist_options";
1669                 $consist =~ s/,/./g;
1670                 $consist =~ s/\//./g;
1671                 $consist =~ s/-/_/g;
1672                 $consist =~ s/[^A-Za-z0-9_.]/ZZ/g; # ToDo: properly?
1673                 $to_do = "echo '\n\t.text\n$consist:' >> $hsc_out";
1674             }
1675             &run_something($to_do, 'Pin on Haskell consistency info');  
1676         }   
1677
1678
1679         # Interface-handling is important enough to live off by itself
1680         if ( $ProduceHi !~ /-nohifile=/ ) { # If we've produced one, process it.
1681            require('ghc-iface.prl') || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-iface.prl!\n");
1682            &postprocessHiFile($hsc_hi, $hifile_target, $going_interactive);
1683         }
1684         # if we're going to split up object files,
1685         # we inject split markers into the .hc file now
1686         if ( $HscOut eq '-C=' && $SplitObjFiles ) {
1687             &inject_split_markers ( $hsc_out );
1688         }
1689
1690         # save a copy of the .hc file, even if we are carrying on...
1691         if ($HscOut eq '-C=' && $do_cc && $Keep_hc_file_too) {
1692             &saveIntermediate($ifile_root , "hc" , $hsc_out);
1693         }
1694
1695     }
1696 }
1697 \end{code}
1698
1699
1700 \begin{code}
1701 sub runHsc {
1702     local($ifile_root, $hsc_out, $hsc_hi, $hsc_out_c_stub, $hsc_out_h_stub, $going_interactive) = @_;
1703
1704     &makeHiMap() unless $HiMapDone;
1705     push(@HsC_flags, "-himap=$HiIncludeString");
1706
1707     # here, we may produce .hc/.s and/or .hi files
1708     local($output) = '';
1709     #@Files_to_tidy = ();
1710
1711     if ( $going_interactive ) {
1712         # don't need .hi unless we're going to show it on stdout:
1713         $ProduceHi = '-nohifile=' if ! ($HiOnStdout || $Specific_hi_file ne '' );
1714         $do_cc = 0; $do_as = 0; $Do_lnkr = 0; # and we won't go any further...
1715     }
1716
1717     # set up for producing output/.hi; note that flag twiddling
1718     # may mean that nothing will actually be produced:
1719     $output = "$ProduceHi$hsc_hi $HscOut$hsc_out -F=$hsc_out_c_stub -FH=$hsc_out_h_stub";
1720     push(@Files_to_tidy, $hsc_hi, $hsc_out, $hsc_out_c_stub, $hsc_out_h_stub );
1721
1722     # if we're compiling foo.hs, we want the GC stats to end up in foo.stat
1723     if ( $CollectingGCstats ) {
1724         push(@HsC_rts_flags, "-S$ifile_root.stat");
1725         push(@Files_to_tidy, "$ifile_root.stat");
1726     }
1727
1728     if ( $CollectGhcTimings ) { # assume $RTS_style eq 'ghc'
1729         # emit nofibbish time/bytes-alloc stats to stderr;
1730         # see later .stat file post-processing
1731         print STDERR "warning: both -Rgc-stats and -Rghc-timing used, -Rghc-timing wins." if $CollectingGCstats;
1732         push(@HsC_rts_flags, "-s$Tmp_prefix.stat");
1733         push(@Files_to_tidy, "$Tmp_prefix.stat");
1734     }
1735
1736     local($dump) = '';
1737     if ($Specific_dump_file ne '') {
1738         $dump = "2>> $Specific_dump_file";
1739         $Using_dump_file = 1;
1740     }
1741
1742     local($to_do);
1743     # Win32 only: If the command processor used by system()
1744     # exec()s the application as an ordinary Win32 executable,
1745     # we're in trouble here, since the command line is likely
1746     # to be > 255 chars long. To work around this situation,
1747     # $HsC also understands `at-files',  i.e., `@file' on the
1748     # command line will cause $HsC to add the contents of `file'
1749     # to the command line.
1750     #
1751     #  [ Note: support for `at-files' is not compiled in by default ]
1752     $cmd_line_opts_via_at_file=0;
1753     if ($cmd_line_opts_via_at_file) {
1754
1755       local($to_do_opts) = "$Tmp_prefix.opts";
1756       open(OPTS, "> $Tmp_prefix.opts") || &tidy_up_and_die(1,"Can't open $Tmp_prefix.opts\n");
1757       print OPTS "$dump @HsC_flags $CoreLint $USPLint $StgLint $Verbose";
1758       close(OPTS);
1759       $to_do = "$HsC $hscpp_hsc \@$Tmp_prefix.opts $output +RTS @HsC_rts_flags";
1760
1761     } else {
1762
1763     $to_do = "$HsC $hscpp_hsc $dump @HsC_flags $CoreLint $USPLint $StgLint $Verbose $output +RTS @HsC_rts_flags";
1764     }
1765     &run_something($to_do, 'Haskell compiler');
1766
1767     # finish business w/ nofibbish time/bytes-alloc stats
1768     &process_ghc_timings() if $CollectGhcTimings;
1769 }
1770 \end{code}
1771
1772 Use \tr{@Import_dir} and \tr{@SysImport_dir} to make a tmp file
1773 of (module-name, pathname) pairs, one per line, separated by a space.
1774 \begin{code}
1775 $HiMapDone = 0;
1776 $HiIncludeString = ();          # dir1:dir2:dir3, to pass to GHC
1777
1778 sub makeHiMap {
1779
1780     # collect in %HiMap; write later; also used elsewhere in driver
1781
1782     local($mod, $path, $d, $e);
1783
1784     # reset the global variables:
1785     $HiMapDone = 0;
1786     $HiIncludeString = ();              # dir1:dir2:dir3, to pass to GHC
1787     
1788     foreach $d ( @Import_dir ) {
1789         if ($HiIncludeString) { 
1790            $HiIncludeString = "$HiIncludeString:${d}%.${HiSuffix}";
1791         } else { 
1792            $HiIncludeString = "$d%.${HiSuffix}"; 
1793         }
1794
1795     }
1796
1797     foreach $d ( @SysImport_dir ) {
1798         if ($HiIncludeString) { 
1799             $HiIncludeString = "$HiIncludeString:${d}%.${HiSuffix_prelude}";
1800         } else { 
1801             $HiIncludeString = "${d}%.${HiSuffix_prelude}";
1802         }
1803     }
1804
1805     $HiMapDone = 1;
1806 }
1807
1808 \end{code}
1809
1810 Invoke the 'linker' - either the standard linker or the one used to build
1811 a (Win32) DLL.
1812
1813 \begin{code}
1814 sub runLinker()
1815 {
1816     local($libdirs) = '';
1817
1818     # append last minute flags linker and consistency flags
1819     &setupBuildFlags();
1820     &setupSyslibs();
1821     &setupLinkOpts();
1822
1823     # glue them together:
1824     push(@UserLibrary_dir, @SysLibrary_dir);
1825
1826     $libdirs = '-L' . join(' -L',@UserLibrary_dir) if $#UserLibrary_dir >= 0;
1827
1828     # for a linker, use an explicitly given one, or the going C compiler ...
1829     local($lnkr) = ( $Lnkr ) ? $Lnkr : $CcRegd;
1830
1831     if ( ($Specific_output_file eq '') && 
1832          ($TargetPlatform eq 'i386-unknown-cygwin32') ) {
1833          $Specific_output_file = 'main.exe';
1834          print STDERR "Output file not specified, defaulting to \"main.exe\"\n";
1835     }
1836
1837     local($output) = ($Specific_output_file ne '') ? "-o $Specific_output_file" : '';
1838     @Files_to_tidy = ($Specific_output_file ne '') ? $Specific_output_file : 'a.out'; 
1839
1840     &prepareWin32DllLink(1);
1841
1842     local($to_do) = "$lnkr $Verbose @Ld_flags $output @Link_file $TopClosureFile $libdirs @UserLibrary @SysLibrary";
1843     &run_something($to_do, 'Linker');
1844
1845     # finally, check the consistency info in the binary
1846     local($executable) = $Files_to_tidy[0];
1847     @Files_to_tidy = (); # reset; we don't want to nuke it if it's inconsistent
1848
1849     if ( $LinkChk ) {
1850         # dynamically load consistency-chking code; then do it.
1851         require('ghc-consist.prl')
1852             || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-consist.prl!\n");
1853
1854         &chk_consistency_info ( $executable );
1855     }
1856
1857     # if PVM parallel stuff, we do truly weird things.
1858     # Essentially: (1) move the executable over to where PVM expects
1859     # to find it.  (2) create a script in place of the executable
1860     # which will cause the program to be run, via SysMan.
1861     if ( $PARing eq 'p' ) {
1862         local($pvm_executable) = $executable;
1863         local($pvm_executable_base);
1864
1865         if ( $pvm_executable !~ /^\// ) { # a relative path name: make absolute
1866             local($pwd) = `pwd`;
1867             chop($pwd);
1868             $pwd =~ s/^\/tmp_mnt//;
1869             $pvm_executable = "$pwd/$pvm_executable";
1870         }
1871
1872         $pvm_executable =~ s|/|=|g; # make /s into =s
1873         $pvm_executable_base = $pvm_executable;
1874
1875         $pvm_executable = $ENV{'PVM_ROOT'} . '/bin/' . $ENV{'PVM_ARCH'}
1876                         . "/$pvm_executable";
1877
1878         &run_something("$Rm -f $pvm_executable; $Cp -p $executable $pvm_executable && $Rm -f $executable", 'Moving binary to PVM land');
1879
1880         # OK, now create the magic script for "$executable"
1881         open(EXEC, "> $executable") || &tidy_up_and_die(1,"$Pgm: couldn't open $executable to write!\n");
1882         print EXEC <<EOSCRIPT1;
1883 eval 'exec perl -S \$0 \${1+"\$@"}'
1884   if \$running_under_some_shell;
1885 # =!=!=!=!=!=!=!=!=!=!=!
1886 # This script is automatically generated: DO NOT EDIT!!!
1887 # Generated by Glasgow Haskell, version ${ProjectVersion} ${ProjectPatchLevel}
1888 #
1889 \$pvm_executable      = '$pvm_executable';
1890 \$pvm_executable_base = '$pvm_executable_base';
1891 \$SysMan = '$SysMan';
1892 EOSCRIPT1
1893
1894         print EXEC <<\EOSCRIPT2;
1895 # first, some magical shortcuts to run "commands" on the binary
1896 # (which is hidden)
1897 if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {
1898     local($cmd) = $1;
1899     system("$cmd $pvm_executable");
1900     exit(0); # all done
1901 }
1902
1903 # OK, really run it; process the args first
1904 $ENV{'PE'} = $pvm_executable_base;
1905 $debug = '';
1906 $nprocessors = 2; # the default
1907 @nonPVM_args = ();
1908 $in_RTS_args = 0;
1909
1910 # ToDo: handle --RTS
1911 args: while ($a = shift(@ARGV)) {
1912     if ( $a eq '+RTS' ) {
1913         $in_RTS_args = 1;
1914     } elsif ( $a eq '-RTS' ) {
1915         $in_RTS_args = 0;
1916     }
1917     if ( $a eq '-d' && $in_RTS_args ) {
1918         $debug = '-';
1919     } elsif ( $a =~ /^-N(\d+)/ && $in_RTS_args ) {
1920         $nprocessors = $1;
1921     } else {
1922         push(@nonPVM_args, $a);
1923     }
1924 }
1925
1926 local($return_val) = 0;
1927 system("$SysMan $debug $pvm_executable $nprocessors @nonPVM_args");
1928 $return_val = $?;
1929 system("mv $ENV{'HOME'}/$pvm_executable_base.???.gr .") if -f "$ENV{'HOME'}/$pvm_executable_base.001.gr";
1930 exit($return_val);
1931 EOSCRIPT2
1932         close(EXEC) || die "Failed closing $executable\n";
1933         chmod 0755, $executable;
1934     }
1935 }
1936
1937 sub createWin32DLL()
1938 {
1939     local ($libdirs);
1940
1941     # append last minute flags linker and consistency flags
1942     &setupBuildFlags();
1943     &setupSyslibs();
1944     &setupLinkOpts();
1945
1946     # glue them together:
1947     push(@UserLibrary_dir, @SysLibrary_dir);
1948
1949     $libdirs = '-L' . join(' -L',@UserLibrary_dir) if $#UserLibrary_dir >= 0;
1950
1951     &prepareWin32DllLink(0);
1952
1953     local ($bld_dll) = "dllwrap";
1954
1955     local ($output) = ($Specific_output_file ne '') ? "$Specific_output_file" : 'HSdll.dll';
1956     local ($output_dir);
1957     local ($output_file);
1958     local ($output_lib, $output_def);
1959
1960     ($output_dir = $output) =~ s|(.*/)[^/]+$|$1|;
1961     $output_dir = "" if ($output_dir eq $output);
1962     ($output_file = $output) =~ s|.*/([^/]+)$|$1|;
1963
1964     ($output_lib = $output_file) =~ s|(.+)\.[^\.]*$|${output_dir}lib$1_imp.a|;
1965     ($output_def = $output_file) =~ s|(.+)\.[^\.]*$|${output_dir}$1.def|;
1966
1967     push (@Dll_flags, "-mno-cygwin --target=i386-mingw32") if ($TargetPlatform =~ /^.*mingw32$/);
1968     push (@Dll_flags, "--output-lib $output_lib");
1969     # If the "--def " option hasn't been supplied, assume everything 
1970     # is going to be exported via the DLL.."
1971     if (!grep(/--def/, @Dll_flags)) {
1972       push (@Dll_flags, "--export-all --output-def $output_def");
1973     }
1974
1975     local($to_do) = "$bld_dll @Dll_flags -o $output @Link_file $libdirs @UserLibrary @SysLibrary";
1976     # Make sure the user sees this piece of magic.
1977     print STDERR "$to_do\n" if (!$Verbose);
1978     &run_something($to_do, 'DLL creator');
1979 }
1980
1981 sub prepareWin32DllLink ()
1982 {
1983     local($linking_main) = @_;
1984
1985     #
1986     # Win32 DLLs - link with import libraries, not the real archives.
1987     # 
1988     if ( $TargetPlatform =~ /-mingw32$/ ) {
1989        if (!$Static) {
1990          #
1991          # If the libraries have the form libHSfoo.a, we
1992          # transform that into libHSfoo_imp.a - the import
1993          # library of the DLL.
1994          # 
1995          foreach $a ( @SysLibrary ) {
1996            $a = "${a}_imp" if ($a =~ /^-lHS/);
1997          }
1998          foreach $a ( @UserLibrary ) {
1999            $a = "${a}_imp" if ($a =~ /^-lHS/);
2000          }
2001          push(@Link_file, ( $INSTALLING ) ? "$InstLibDirGhc/Main.o"
2002                                           : "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR/Main.o") if $linking_main;
2003          push(@Link_file, ( $INSTALLING ) ? "$InstLibDirGhc/PrelMain.o"
2004                                           : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/PrelMain.o") if $linking_main;
2005        }
2006        push(@Ld_flags,  "-mno-cygwin");
2007     }
2008 }
2009 \end{code}
2010
2011
2012 %************************************************************************
2013 %*                                                                      *
2014 \section[Driver-misc-utils]{Miscellaneous utilities}
2015 %*                                                                      *
2016 %************************************************************************
2017
2018 %************************************************************************
2019 %*                                                                      *
2020 \subsection[Driver-odir-ify]{@odir_ify@: Mangle filename if \tr{-odir} set}
2021 %*                                                                      *
2022 %************************************************************************
2023
2024 \begin{code}
2025 sub osuf_ify {
2026     local($ofile,$def_suffix) = @_;
2027
2028     return(($Osuffix eq '') ? "$ofile.$def_suffix" : "$ofile.$Osuffix" );
2029 }
2030
2031 sub odir_ify {
2032     local($orig_file, $def_suffix) = @_;
2033     if ($Specific_output_dir eq '') {   # do nothing
2034         &osuf_ify($orig_file, $def_suffix);
2035     } else {
2036         local ($orig_file_only);
2037         ($orig_file_only = $orig_file) =~ s|.*/||;
2038         &osuf_ify("$Specific_output_dir/$orig_file_only",$def_suffix);
2039     }
2040 }
2041 \end{code}
2042
2043 \begin{code}
2044 sub runGcc {
2045     local($is_hc_file, $hsc_out, $cc_as_o) = @_;
2046
2047     local($includes) = '-I' . join(' -I', @Include_dir);
2048     local($cc);
2049     local($s_output);
2050     local($c_flags) = "@CcBoth_flags";
2051     local($ddebug_flag) = ( $DEBUGging ) ? '-DDEBUG' : '';
2052
2053     $c_flags .= " -mno-cygwin" if ( $TargetPlatform =~ /-mingw32$/ );
2054
2055     # "input" files to use that are not in some weird directory;
2056     # to help C compilers grok .hc files [ToDo: de-hackify]
2057     local($cc_help)   = "ghc$$.c";
2058     local($cc_help_s) = "ghc$$.s";
2059
2060     $cc       = $CcRegd;
2061     $s_output = (($is_hc_file && $DoAsmMangling) || $TargetPlatform =~ /^(powerpc|rs6000|hppa)/) ? $cc_as_o : $cc_as;
2062     $c_flags .= " @CcRegd_flags";
2063     $c_flags .= ($is_hc_file) ? " @CcRegd_flags_hc"  : " @CcRegd_flags_c";
2064
2065     # C compiler won't like the .hc extension.  So we create
2066     # a tmp .c file which #include's the needful.
2067     open(TMP, "> $cc_help") || &tidy_up_and_die(1,"$Pgm: failed to open `$cc_help' (to write)\n");
2068     if ( $is_hc_file ) {
2069         print TMP <<EOINCL;
2070 #include "Stg.h"
2071 EOINCL
2072         # user may have asked for #includes to be injected...
2073         print TMP @CcInjects if $#CcInjects >= 0;
2074     } else {
2075         # Straight .c files may want to know that they're being used
2076         # with a particular version of GHC, so we define __GLASGOW_HASKELL__ for their benefit.
2077         print TMP "#define __GLASGOW_HASKELL__ ${ProjectVersionInt}\n";
2078     }
2079     # heave in the consistency info
2080     print TMP "static char ghc_cc_ID[] = \"\@(#)cc $ifile\t$Cc_major_version.$Cc_minor_version,$Cc_consist_options\";\n";
2081
2082     print TMP "#include \"$hsc_out\"\n";
2083     close(TMP) || &tidy_up_and_die(1,"Failed writing to $cc_help\n");
2084
2085     # Don't redirect stderr into intermediate file if slamming output onto stdout (e.g., with -E)
2086     local($fuse_stderr) = "2>&1" if ! $Only_preprocess_hc;
2087     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 )";
2088
2089     if ( $Only_preprocess_hc ) { # HACK ALERT!
2090         $to_do =~ s/ -S\b//g;
2091     }
2092     push(@Files_to_tidy, $cc_help, $cc_help_s, $s_output );
2093     $PostprocessCcOutput = 1 if ! $Only_preprocess_hc;  # hack, dear hack...
2094     &run_something($to_do, 'C compiler');
2095     $PostprocessCcOutput = 0;
2096     if ( $Only_preprocess_hc ) {
2097        system("$Cat $Tmp_prefix.ccout");
2098     }
2099     unlink($cc_help, $cc_help_s);
2100 }
2101 \end{code}
2102
2103 \begin{code}
2104 sub runMangler {
2105     local($is_hc_file, $cc_as_o, $cc_as, $ifile_root) = @_;
2106
2107     print STDERR `cat $cc_as_o` if $Dump_raw_asm; # to stderr, before mangling
2108
2109     if ($is_hc_file && $DoAsmMangling) {
2110         # dynamically load assembler-fiddling code, which we are about to use:
2111         require('ghc-asm.prl')
2112              || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm.prl!\n");
2113         # post-process the assembler [.hc files only]
2114         &mangle_asm($cc_as_o, $cc_as);
2115
2116     } elsif ($TargetPlatform =~ /^hppa/) {
2117         # minor mangling of non-threaded files for hp-pa only
2118         require('ghc-asm.prl')
2119         || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-hppa.prl!\n");
2120         &mini_mangle_asm_hppa($cc_as_o, $cc_as);
2121
2122     } elsif ($TargetPlatform =~ /^powerpc|^rs6000/) {
2123         # minor mangling of non-threaded files for powerpcs and rs6000s 
2124         require('ghc-asm.prl')
2125         || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-powerpc.prl!\n");
2126         &mini_mangle_asm_powerpc($cc_as_o, $cc_as);
2127     }
2128
2129     # save a copy of the .s file, even if we are carrying on...
2130     #if ($do_as && $Keep_s_file_too) {
2131     #    &saveIntermediate($ifile_root , "s" , $cc_as);
2132     #}
2133 }
2134 \end{code}
2135
2136 \begin{code}
2137 sub runAs {
2138     local($as_out, $ifile_root) = @_;
2139
2140     local($asmblr) = ( $As ) ? $As : $CcRegd;
2141
2142     # need to add the -I flags in case the file is going through cpp (.S files)
2143     local($includes) = '-I' . join(' -I', @Include_dir);
2144
2145     if ( ! $SplitObjFiles ) {
2146         local($to_do)  = "$asmblr -o $as_out -c @As_flags $includes $cc_as";
2147         push(@Files_to_tidy, $as_out );
2148         &run_something($to_do, 'Unix assembler');
2149
2150     } else { # more complicated split-ification...
2151
2152         # must assemble files $Tmp_prefix__[1 .. $NoOfSplitFiles].s
2153
2154         # If -odir is used, great, just pin it in front of the
2155         # generated split file names. If it hasn't been set, we
2156         # snatch it from the ifile_root.
2157         #
2158         # 
2159
2160         if ( $Specific_output_dir eq '' ) {
2161             $Specific_output_dir = ${ifile_root};
2162         }
2163
2164         for ($f = 1; $f <= $NoOfSplitFiles; $f++ ) {
2165             local($split_out) = &odir_ify("${ifile_root}__${f}",'o');
2166             local($to_do) = "$asmblr -o $split_out -c @As_flags ${Tmp_prefix}__${f}.s";
2167             push(@Files_to_tidy, $split_out );
2168
2169             &run_something($to_do, 'Unix assembler');
2170         }
2171     }
2172 }
2173 \end{code}
2174
2175 %************************************************************************
2176 %*                                                                      *
2177 \subsection[Driver-run-something]{@run_something@: Run a phase}
2178 %*                                                                      *
2179 %************************************************************************
2180
2181 \begin{code}
2182 sub run_something {
2183     local($str_to_do, $tidy_name) = @_;
2184
2185     print STDERR "\n$tidy_name:\n\t" if $Verbose;
2186     print STDERR "$str_to_do\n" if $Verbose;
2187
2188     if ($Using_dump_file) {
2189         open(DUMP, ">> $Specific_dump_file")
2190             || &tidy_up_and_die(1,"$Pgm: failed to open `$Specific_dump_file'\n");
2191         print DUMP "\nCompilation Dump for: $str_to_do\n\n";
2192         close(DUMP) 
2193             || &tidy_up_and_die(1,"$Pgm: failed closing `$Specific_dump_file'\n");
2194     }
2195
2196     local($return_val) = 0;
2197
2198     if ( length($str_to_do) > 4000) { 
2199       # 4000 - on the random side, just like the *real* ARG_MAX 
2200       # for some shells.
2201
2202       # With some shells, command lines of this length may
2203       # very well cause trouble. To safeguard against this, we squirrel the
2204       # command into a file and exec that.
2205       local ($sh) = $ENV{'REAL_SHELL'};
2206       print STDERR "Backup plan A: saving cmd line in ${Tmp_prefix}.sh and executing that with $sh\n" if $Verbose;
2207       open (TEMP, "> ${Tmp_prefix}.sh") || 
2208                 &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.sh'\n");
2209       print TEMP "$Time $str_to_do\n";
2210       close (TEMP) ||
2211                 &tidy_up_and_die(1,"$Pgm: failed closing `$Tmp_prefix.sh'\n");
2212       system("$sh $Tmp_prefix.sh");
2213       $return_val = $?;
2214       
2215       unlink "${Tmp_prefix}.sh";
2216     } else {
2217       system("$Time $str_to_do");
2218       $return_val = $?;
2219     }
2220
2221     if ( $PostprocessCcOutput ) { # hack, continued
2222         open(CCOUT, "< $Tmp_prefix.ccout")
2223             || &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.ccout'\n");
2224         while ( <CCOUT> ) {
2225             next if /call-clobbered/;
2226             next if /control reaches end/;
2227             next if /from .*Stg\.h:/;
2228             next if /from ghc\d+.c:\d+:/;
2229             next if /: At top level:$/;
2230             next if /: In function \`.*\':$/;
2231             next if /\`ghc_cc_ID\' defined but not used/;
2232             print STDERR $_;
2233         }
2234         close(CCOUT) || &tidy_up_and_die(1,"$Pgm: failed closing `$Tmp_prefix.ccout'\n");
2235     }
2236
2237     if ($return_val != 0) {
2238         if ($Using_dump_file) {
2239             print STDERR "Compilation Errors dumped in $Specific_dump_file\n";
2240         }
2241         &tidy_up_and_die($return_val, '');
2242     }
2243     $Using_dump_file = 0;
2244 }
2245 \end{code}
2246
2247 %************************************************************************
2248 %*                                                                      *
2249 \subsection[Driver-ghc-timing]{Emit nofibbish GHC timings}
2250 %*                                                                      *
2251 %************************************************************************
2252
2253 NB: nearly the same as in @runstdtest@ script.
2254
2255 \begin{code}
2256 sub process_ghc_timings {
2257     local($StatsFile) = "$Tmp_prefix.stat";
2258     local($SysSpecificTiming) = 'ghc';
2259
2260     open(STATS, $StatsFile) || die "Failed when opening $StatsFile\n";
2261     local($max_live)    = 0; 
2262     local($tot_live)    = 0; # for calculating residency stuff
2263     local($tot_samples) = 0;
2264
2265     while (<STATS>) {
2266         if (! /Gen:\s+0/ && ! /Minor/ && /^\s*\d+\s+\d+\s+(\d+)\s+\d+\.\d+/ ) {
2267                 $max_live = $1 if $max_live < $1;
2268                 $tot_live += $1;
2269                 $tot_samples += 1;
2270         }
2271         $BytesAlloc = $1 if /^\s*([0-9,]+) bytes allocated in the heap/;
2272
2273         if ( /^\s*([0-9,]+) bytes maximum residency .* (\d+) sample/ ) {
2274             $MaxResidency = $1; $ResidencySamples = $2;
2275         }
2276
2277         $GCs = $1 if /^\s*([0-9,]+) (collections? in generation 0|garbage collections? performed)/;
2278
2279         if ( /^\s+([0-9]+)\s+Mb total memory/ ) {
2280             $TotMem = $1;
2281         }
2282
2283         # The presence of -? in the following pattern is only there to
2284         # accommodate 0.29 && <= 2.05 RTS'
2285         if ( /^\s*INIT\s+time\s*(\d+\.\d\d)s\s*\(\s*-?(\d+\.\d\d)s elapsed\)/ ) {
2286             $InitTime = $1; $InitElapsed = $2;
2287         } elsif ( /^\s*MUT\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2288             $MutTime = $1; $MutElapsed = $2;
2289         } elsif ( /^\s*GC\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2290             $GcTime = $1; $GcElapsed = $2;
2291         }
2292     }
2293     close(STATS) || die "Failed when closing $StatsFile\n";
2294     if ( $tot_samples > 0 ) {
2295         $ResidencySamples = $tot_samples;
2296         $MaxResidency = $max_live;
2297         $AvgResidency = int ($tot_live / $tot_samples) ;
2298     }
2299
2300     # warn about what we didn't find
2301     print STDERR "Warning: BytesAlloc not found in stats file\n" unless defined($BytesAlloc);
2302     print STDERR "Warning: GCs not found in stats file\n" unless defined($GCs);
2303     print STDERR "Warning: InitTime not found in stats file\n" unless defined($InitTime);
2304     print STDERR "Warning: InitElapsed not found in stats file\n" unless defined($InitElapsed);
2305     print STDERR "Warning: MutTime not found in stats file\n" unless defined($MutTime);
2306     print STDERR "Warning: MutElapsed not found in stats file\n" unless defined($MutElapsed);
2307     print STDERR "Warning: GcTime inot found in stats file\n" unless defined($GcTime);
2308     print STDERR "Warning: GcElapsed not found in stats file\n" unless defined($GcElapsed);
2309
2310     # things we didn't necessarily expect to find
2311     $MaxResidency     = 0 unless defined($MaxResidency);
2312     $AvgResidency     = 0 unless defined($AvgResidency);
2313     $ResidencySamples = 0 unless defined($ResidencySamples);
2314
2315     # a bit of tidying
2316     $BytesAlloc =~ s/,//g;
2317     $MaxResidency =~ s/,//g;
2318     $GCs =~ s/,//g;
2319     $InitTime =~ s/,//g;
2320     $InitElapsed =~ s/,//g;
2321     $MutTime =~ s/,//g;
2322     $MutElapsed =~ s/,//g;
2323     $GcTime =~ s/,//g;
2324     $GcElapsed =~ s/,//g;
2325
2326     # print out what we found
2327     print STDERR "<<$SysSpecificTiming: ",
2328         "$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)",
2329         " :$SysSpecificTiming>>\n";
2330
2331     # OK, party over
2332     unlink $StatsFile;
2333 }
2334 \end{code}
2335
2336 %************************************************************************
2337 %*                                                                      *
2338 \subsection[Driver-dying]{@tidy_up@ and @tidy_up_and_die@: Dying gracefully}
2339 %*                                                                      *
2340 %************************************************************************
2341
2342 \begin{code}
2343 sub tidy_up {
2344     local($to_do) = "\n$Rm $Tmp_prefix*";
2345     if ( $Tmp_prefix !~ /^\s*$/ ) {
2346         print STDERR "$to_do\n" if $Verbose;
2347         system($to_do);
2348     }
2349 }
2350
2351 sub tidy_up_and_die {
2352     local($return_val, $msg) = @_;
2353
2354     # delete any files to tidy
2355     print STDERR "deleting... @Files_to_tidy\n" if $Verbose && $#Files_to_tidy >= 0;
2356     unlink @Files_to_tidy if $#Files_to_tidy >= 0;
2357
2358     &tidy_up();
2359     print STDERR $msg;
2360     exit (($return_val == 0) ? 0 : 1);
2361 }
2362 \end{code}
2363
2364 %************************************************************************
2365 %*                                                                      *
2366 \subsection[Driver-arg-with-arg]{@grab_arg_arg@: Do an argument with an argument}
2367 %*                                                                      *
2368 %************************************************************************
2369
2370 Some command-line arguments take an argument, e.g.,
2371 \tr{-Rmax-heapsize} expects a number to follow.  This can either be
2372 given a part of the same argument (\tr{-Rmax-heapsize8M}) or as the
2373 next argument (\tr{-Rmax-heapsize 8M}).  We allow both cases.
2374
2375 Note: no error-checking; \tr{-Rmax-heapsize -Rgc-stats} will silently
2376 gobble the second argument (and probably set the heapsize to something
2377 nonsensical).
2378 \begin{code}
2379 sub grab_arg_arg {
2380     local(*Args, $option, $rest_of_arg) = @_;
2381     
2382     if ($rest_of_arg ne '') {
2383         return($rest_of_arg);
2384     } elsif ($#Args >= 0) {
2385         local($temp) = $Args[0]; shift(@Args); 
2386         return($temp);
2387     } else {
2388         print STDERR "$Pgm: no argument following $option option\n";
2389         $Status++;
2390     }
2391 }
2392 \end{code}
2393
2394 \begin{code}
2395 sub isntAntiFlag {
2396     local($flag) = @_;
2397     local($f);
2398
2399 #Not in HsC_antiflag ## NO!: and not already in HsC_flags
2400
2401     foreach $f ( @HsC_antiflags ) {
2402         return(0) if $flag eq $f;
2403     }
2404 #    foreach $f ( @HsC_flags ) {
2405 #       return(0) if $flag eq $f;
2406 #    }
2407     return(1);
2408 }
2409
2410 sub squashHscFlag {  # pretty terrible
2411     local($flag) = @_;
2412     local($f);
2413
2414     foreach $f ( @HsC_flags ) {
2415         if ($flag eq $f) { $f = ''; }
2416     }
2417 }
2418
2419 sub add_Hsc_flags {
2420     local(@flags) = @_;
2421     local($f);
2422
2423     foreach $f ( @flags ) {
2424         push( @HsC_flags, $f ) if &isntAntiFlag($f);
2425     }
2426 }
2427 \end{code}
2428
2429 To add another system library, you'll need to augment the
2430 Supported_syslibs variable with name and info on your addition
2431 to the syslib family. The info bit consist of the following:
2432
2433    - interface file directory
2434        see the misc or posix entry for how to distinguish
2435        between using installed and build tree directories.
2436        
2437    - directory location of archives
2438        
2439    - location of (way-independent) C support libs.
2440        not all libraries need this - if you don't, just
2441        give the empty string.
2442    - list of syslibs you depend on.
2443
2444    - additional ghc command line flags that should be used.
2445    - additional C compiler command line flags that should be used.
2446    - link 
2447
2448
2449 \begin{code}
2450
2451 # Hash to keep track of 
2452 %Syslibs_added = ();
2453
2454 sub add_syslib {
2455     local($syslib) = @_;
2456
2457     # Lifting this out of this sub brings it out of scope - why??
2458     %Supported_syslibs =
2459      ( exts,
2460         [  # where to slurp interface files from
2461           ( $INSTALLING 
2462                ? "$InstLibDirGhc/imports/exts"
2463                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/exts"
2464           )
2465         , # where to find the archive to use when linking
2466           ( $INSTALLING 
2467                ? "$InstLibDirGhc"
2468                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/exts"
2469           )
2470         , '' # no cbits
2471         , '' # Syslib dependencies
2472         , '' # extra ghc opts
2473         , '' # extra cc opts
2474         , '' # extra ld opts
2475         ],
2476
2477        misc,
2478         [  # where to slurp interface files from
2479           ( $INSTALLING 
2480                ? "$InstLibDirGhc/imports/misc"
2481                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/misc"
2482           )
2483         , # where to find the archive to use when linking
2484           ( $INSTALLING 
2485                ? "$InstLibDirGhc"
2486                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/misc"
2487           )
2488         , # where to find the cbits archive to use when linking
2489           ( $INSTALLING 
2490                ? "$InstLibDirGhc"
2491                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/misc/cbits"
2492           )
2493         , 'exts' # Syslib dependencies
2494         , ''     # extra ghc opts
2495         , ''     # extra cc opts
2496         , ( $TargetPlatform =~ /-solaris2$/  ? '-lnsl -lsocket' : '')
2497         ],
2498        hbc,
2499         [  # where to slurp interface files from
2500           ( $INSTALLING 
2501                ? "$InstLibDirGhc/imports/hbc"
2502                : "$TopPwd/CONTRIB/libraries/hbc/src"
2503           )
2504         , # where to find the archive to use when linking
2505           ( $INSTALLING 
2506                ? "$InstLibDirGhc"
2507                : "$TopPwd/CONTRIB/libraries/src/hbc"
2508           )
2509         , # where to find the cbits archive to use when linking
2510           ( $INSTALLING 
2511                ? "$InstLibDirGhc"
2512                : "$TopPwd/CONTRIB/libraries/hbc/cbits"
2513           )
2514         , 'exts' # Syslib dependencies
2515         , ''     # extra ghc opts
2516         , ''     # extra cc opts
2517         , ''
2518         ],
2519        posix,
2520         [  # where to slurp interface files from
2521           ( $INSTALLING 
2522                ? "$InstLibDirGhc/imports/posix"
2523                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/posix"
2524           )
2525         , # where to find the archive to use when linking
2526           ( $INSTALLING 
2527                ? "$InstLibDirGhc"
2528                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/posix"
2529           )
2530         , # where to find the cbits archive to use when linking
2531           ( $INSTALLING 
2532                ? "$InstLibDirGhc"
2533                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/posix/cbits"
2534           )
2535         , 'misc' # Syslib dependencies
2536         , ''     # extra ghc opts
2537         , ''     # extra cc opts
2538         , ''     # extra ld opts
2539         ],
2540        concurrent,
2541         [  # where to slurp interface files from
2542           ( $INSTALLING 
2543                ? "$InstLibDirGhc/imports/concurrent"
2544                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/concurrent"
2545           )
2546         , # where to find the archive to use when linking
2547           ( $INSTALLING 
2548                ? "$InstLibDirGhc"
2549                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/concurrent"
2550           )
2551         , '' # where to find the cbits archive to use when linking
2552         , '' # Syslib dependencies
2553         , '' # extra ghc opts
2554         , '' # extra cc opts
2555         , '' # extra ld opts
2556         ],
2557        win32,
2558         [  # where to slurp interface files from
2559           ( $INSTALLING 
2560                ? "$InstLibDirGhc/imports/win32"
2561                : "$TopPwd/hslibs/win32/src"
2562           )
2563         , # where to find the archive to use when linking
2564           ( $INSTALLING 
2565                ? "$InstLibDirGhc"
2566                : "$TopPwd/hslibs/win32/src"
2567           )
2568         , ''
2569         , 'exts' # Syslib dependencies
2570         , ''     # extra ghc opts
2571         , ''     # extra cc opts
2572         , '-luser32 -lgdi32'     # extra ld opts
2573         ],
2574        com,
2575         [  # where to slurp interface files from
2576           ( $INSTALLING 
2577                ? "$InstLibDirGhc/imports/com"
2578                : "$TopPwd/hdirect/lib"
2579           )
2580         , # where to find the archive to use when linking
2581           ( $INSTALLING 
2582                ? "$InstLibDirGhc"
2583                : "$TopPwd/hdirect/lib"
2584           )
2585         , ''
2586         , 'exts' # Syslib dependencies
2587         , ''     # extra ghc opts
2588         , ''     # extra cc opts
2589         , '-luser32 -lole32 -loleaut32 -ladvapi32'
2590                  # extra ld opts
2591         ]
2592     );
2593
2594     # check if it's supported..
2595     
2596     if ( !exists $Supported_syslibs{$syslib} ) {
2597        print STDERR "$Pgm: no such system library (-syslib): $syslib\n";
2598        $Status++;
2599        return;
2600     }
2601
2602     # This check is here to avoid syslib loops from
2603     # spoiling the party. A side-effect of it is that
2604     # it disallows multiple mentions of a syslib on a command-line,
2605     # explicit *and* implicit ones (i.e., "-syslib exts -syslib misc"
2606     # is not equal to "-syslib exts -syslib misc -syslib exts",
2607     # which it needs to be)
2608     # 
2609     # Since our current collection of syslibs don't have any
2610     # loops, this test is disabled.
2611     #
2612     # ToDo: loop avoidance scheme when the need arises
2613     #
2614     #return if ( exists $Syslibs_added{$syslib} );
2615         
2616     $Syslibs_added{$syslib} = 1;
2617
2618     local ($hi_dir, $lib_dir, $lib_cbits_dir,
2619            $syslib_deps, $syslib_ghc_opts,
2620            $syslib_cc_opts, $syslib_ld_opts) = @{ $Supported_syslibs{$syslib} };
2621
2622
2623     unshift(@SysImport_dir, $hi_dir);
2624     push(@SysLibrary_dir, $lib_dir);
2625     push(@SysLibrary_dir, $lib_cbits_dir) if ( $lib_cbits_dir ne '');
2626
2627     push(@SysLibrary, "-lHS$syslib");
2628     push(@SysLibrary, "-lHS${syslib}_cbits") if ( $lib_cbits_dir ne '');
2629     push(@SysLibrary, $syslib_ld_opts) if ($syslib_ld_opts ne '');   
2630
2631     # Add on any extra dependencies.
2632     foreach $lib (split(' ',$syslib_deps)) {
2633       &add_syslib($lib);
2634     }
2635 }
2636 \end{code}
2637
2638 Source files may have {-# OPTIONS ... #-} pragmas at the top, containing
2639 command line options we want to append to collection of commands specified
2640 directly. @check_for_source_options@ looks at the top of a de-lit'ified Haskell
2641 file for any such pragmas:
2642
2643 \begin{code}
2644 sub check_for_source_options {
2645     local($file,$ifile) = @_;
2646     local($comment_start,$comment_end);
2647
2648     if ($ifile =~ /\.hc$/ || 
2649         $ifile =~ /_hc$/  || 
2650         $ifile =~ /\.s$/  || 
2651         $ifile =~ /_s$/ ) {  # `Real' C intermediate
2652        $comment_start = "/\\*";
2653        $comment_end   = "\\*/";
2654     } else { # Assume it is a file containing Haskell source
2655        $comment_start = "{-#";
2656        $comment_end   = "#-}";
2657     }
2658
2659     open(FILE,$file) || return(1); # No big loss
2660     
2661     while (<FILE>) {
2662         if ( /^${comment_start} OPTIONS (.*)${comment_end}$/ ) {
2663            # add the options found at the back of the command line.
2664            local(@entries) = split(/\s+/,$1);
2665            print STDERR "Found OPTIONS " . join(' ',@entries) . " in $file\n" if $Verbose;
2666            push(@File_options, @entries);
2667         }
2668         elsif ( /^$/ ) { # ignore empty lines
2669            ;
2670         }
2671         elsif ( /^#line.+$/ ) { # ignore comment lines (unused..ToDo: rm )
2672            ;
2673         }
2674         elsif ( /^{-# LINE.+$/ ) { # ignore line pragmas
2675            ;
2676         }
2677         else { # stop looking, something non-empty / not
2678                # ${comment_start} OPTIONS .. ${comment_end} encountered.
2679             close(FILE);return(0);
2680         }
2681     }
2682     close(FILE);
2683     return(0);
2684 }
2685 \end{code}
2686
2687
2688 We split the initial argv up into three arrays:
2689
2690   - @Cmd_opts 
2691   - @Link_file
2692   - @Input_file
2693
2694 the reason for doing so is to be able to deal
2695 with {-# OPTIONS #-} pragma in source files properly.
2696
2697 \begin{code}
2698 sub splitCmdLine {
2699     local(@args) = @_;
2700
2701 arg: while($_ = $args[0]) {
2702     shift(@args);
2703     # sigh, we have to deal with these -option arg specially here.
2704     /^-(tmpdir|odir|ohi|o|isuf|osuf|hisuf|odump|syslib)$/ && 
2705        do { push(@Cmd_opts, $_); push(@Cmd_opts,$args[0]); shift(@args); next arg; };
2706     /^--?./  && do { push(@Cmd_opts, $_); next arg; };
2707
2708     if (/\.([^_]+_)?[oa]$/) {
2709         push(@Link_file, $_);
2710     } else {
2711         push(@Input_file, $_);
2712     }
2713
2714     # input files must exist:
2715     if (! -f $_) {
2716         print STDERR "$Pgm: input file doesn't exist: $_\n";
2717         $Status++;
2718     }
2719   }
2720 }    
2721
2722 \end{code}
2723
2724 When saving an intermediate file (.hc or .s) away, we 
2725 have to prefix any OPTIONS found in the original source file.
2726
2727 \begin{code}
2728 sub saveIntermediate { 
2729   local ($final,$suffix,$tmp)= @_ ;
2730   local ($to_do);
2731
2732   # $final  -- root of where to park ${final}.${suffix}
2733   # $tmp    -- temporary file where hsc put the intermediate file.
2734
2735   # Delete the old file
2736   $to_do = "$Rm ${final}.${suffix}"; &run_something($to_do, "Removing old .${suffix} file");
2737
2738   if ( $#File_options >= 0 ) { # OPTIONS found in Haskell source unit
2739     # Add OPTION comment to the top of the generated .${suffix} file
2740     open(TEMP, "> ${final}.${suffix}") || &tidy_up_and_die(1,"Can't open ${final}.${suffix}\n");
2741     print TEMP "/* OPTIONS " . join(' ',@File_options) . " */\n";
2742     close(TEMP);
2743     print STDERR "Prepending OPTIONS: " . join(' ',@File_options) . " to ${final}.${suffix}\n" if $Verbose;
2744   }
2745   $to_do = "$Cat $tmp  >> ${final}.${suffix}";
2746   &run_something($to_do, "Saving copy of .${suffix} file");
2747
2748 }
2749
2750 \end{code}
2751
2752
2753 Command-line processor
2754
2755 \begin{code}
2756 sub processArgs {
2757     local(@Args) = @_;
2758
2759 # can't use getopt(s); what we want is too complicated
2760
2761 arg: while($_ = $Args[0]) {
2762     shift(@Args);
2763
2764     #---------- help -------------------------------------------------------
2765     if (/^-\?$/ || /^--?help$/) { print $LongUsage; exit $Status; }
2766
2767     #-----------version ----------------------------------------------------
2768     /^--version$/   && do { print STDERR "${ProjectName}, version ${ProjectVersion}, patchlevel ${ProjectPatchLevel}\n"; exit $Status; };
2769
2770     #---------- verbosity and such -----------------------------------------
2771     /^-v$/          && do { $Verbose = '-v'; $Time = 'time'; next arg; };
2772
2773     #---------- what phases are to be run ----------------------------------
2774     /^-(no-)?recomp/        && do { $Do_recomp_chkr = ($1 eq '') ? 1 : 0; next arg; };
2775
2776     /^-cpp$/        && do { $Cpp_flag_set = 1; next arg; };
2777     # change the global default:
2778     # we won't run cat; we'll run the real thing
2779         
2780     /^-C$/          && do { $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0; $HscOut = '-C=';
2781                             next arg; };
2782     # stop after generating C
2783         
2784     /^-noC$/        && do { $HscOut = '-N='; $ProduceHi = '-nohifile=';
2785                             $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0;
2786                             next arg; };
2787     # leave out actual C generation (debugging) [also turns off interface gen]
2788
2789
2790     /^-hi$/              && do { $HiOnStdout = 1; $ProduceHi = '-hifile='; next arg; };
2791     # _do_ generate an interface; usually used as: -noC -hi
2792     /^-hi-with-(.*)$/    && do { $HiOnStdout = 1; $HiWith .= " $1" ; $ProduceHi = '-hifile='; next arg; };
2793     # limit ourselves to outputting a particular section.
2794
2795     /^-nohi$/       && do { $ProduceHi = '-nohifile='; next arg; };
2796     # don't generate an interface (even if generating C)
2797
2798     /^-hi-diffs$/             && do { $HiDiff_flag  = 'normal'; next arg; };
2799     /^-hi-diffs-with-usages$/ && do { $HiDiff_flag  = 'usages'; next arg; };
2800     /^-no-hi-diffs$/          && do { $HiDiff_flag  = '';       next arg; };
2801     /^-keep-hi-diffs$/        && do { $Keep_HiDiffs = 1; next arg; };
2802
2803     # show/disable diffs if the interface file changes
2804
2805     /^-E$/          && do { push(@CcBoth_flags, '-E');
2806                             $Only_preprocess_C = 1;
2807                             $Do_as = 0; $Do_lnkr = 0; next arg; };
2808     # stop after preprocessing C
2809     /^-M$/          && do { $Only_generate_deps = 1; $Do_as = 0; $Do_lnkr = 0; next arg; };
2810     # only generate dependency information.
2811     /^--mk-dll$/    && do { $Only_generate_dll  = 1; $Do_as = 0; $Do_lnkr = 0; next arg; };
2812     # Build a Win32 DLL (where supported).
2813     /^-S$/          && do { $Do_as = 0; $Do_lnkr = 0; next arg; };
2814     # stop after generating assembler
2815         
2816     /^-c$/          && do { $Do_lnkr = 0; next arg; };
2817     # stop after generating .o files
2818
2819     /^-link-chk$/    && do { $LinkChk = 1; next arg; };
2820     # don't do consistency-checking after a link
2821     /^-no-link-chk$/ && do { $LinkChk = 0; next arg; };
2822
2823     /^-tmpdir$/ && do { $Tmp_prefix = &grab_arg_arg(*Args,'-tmpdir', '');
2824                         $Tmp_prefix = "$Tmp_prefix/ghc$$";
2825                         $ENV{'TMPDIR'} = $Tmp_prefix; # for those who use it...
2826                         next arg; };
2827     # use an alternate directory for temp files
2828
2829     #---------- redirect output --------------------------------------------
2830
2831     # -o <file>; applies to the last phase, whatever it is
2832     # "-o -" sends it to stdout
2833     # if <file> has a directory component, that dir must already exist
2834
2835     /^-odir$/       && do { $Specific_output_dir = &grab_arg_arg(*Args,'-odir', '');
2836                             #
2837                             # Hack, of the worst sort: don't do validation of
2838                             # odir argument if you're using -M (dependency generation).
2839                             #
2840                             if ( ! $Only_generate_deps && ! -d $Specific_output_dir) {
2841                                 print STDERR "$Pgm: -odir: no such directory: $Specific_output_dir\n";
2842                                 $Status++;
2843                             }
2844                             next arg; };
2845
2846     /^-o$/          && do { $Specific_output_file = &grab_arg_arg(*Args,'-o', '');
2847                             if ($Specific_output_file ne '-'
2848                              && $Specific_output_file =~ /(.*)\/[^\/]*$/) {
2849                                 local($dir_part) = $1;
2850                                 if (! -d $dir_part) {
2851                                     print STDERR "$Pgm: no such directory: $dir_part\n";
2852                                     $Status++;
2853                                 }
2854                             }
2855                             next arg; };
2856
2857     # NB: -isuf not documented yet (because it doesn't work yet)
2858     /^-isuf$/       && do { $Isuffix  = &grab_arg_arg(*Args,'-isuf', '');
2859                             if ($Isuffix =~ /\./ ) {
2860                                 print STDERR "$Pgm: -isuf suffix shouldn't contain a .\n";
2861                                 $Status++;
2862                             }
2863                             next arg; };
2864
2865     /^-osuf$/       && do { $Osuffix  = &grab_arg_arg(*Args,'-osuf', '');
2866                             if ($Osuffix =~ /\./ ) {
2867                                 print STDERR "$Pgm: -osuf suffix shouldn't contain a .\n";
2868                                 $Status++;
2869                             }
2870                             next arg; };
2871
2872     # -ohi <file>; send the interface to <file>; "-ohi -" to send to stdout
2873     /^-ohi$/        && do { $Specific_hi_file = &grab_arg_arg(*Args,'-ohi', '');
2874                             if ($Specific_hi_file ne '-'
2875                              && $Specific_hi_file =~ /(.*)\/[^\/]*$/) {
2876                                 local($dir_part) = $1;
2877                                 if (! -d $dir_part) {
2878                                     print STDERR "$Pgm: no such directory: $dir_part\n";
2879                                     $Status++;
2880                                 }
2881                             }
2882                             $ProduceHi='-hifile=';
2883                             next arg; };
2884
2885     # The suffix to use when looking for interface files
2886     /^-hisuf$/      && do { $HiSuffix = &grab_arg_arg(*Args,'-hisuf', '');
2887                             if ($HiSuffix =~ /\./ ) {
2888                                 print STDERR "$Pgm: -hisuf suffix shouldn't contain a .\n";
2889                                 $Status++;
2890                             }
2891                             next arg; };
2892     /^-odump$/      && do { $Specific_dump_file = &grab_arg_arg(*Args,'-odump', '');
2893                             if ($Specific_dump_file =~ /(.*)\/[^\/]*$/) {
2894                                 local($dir_part) = $1;
2895                                 if (! -d $dir_part) {
2896                                     print STDERR "$Pgm: no such directory: $dir_part\n";
2897                                     $Status++;
2898                                 }
2899                             }
2900                             next arg; };
2901
2902     #-------------- scc & Profiling Stuff ----------------------------------
2903
2904     /^-prof$/ && do { $PROFing = 'p'; next arg; }; # profiling -- details later!
2905
2906     /^-auto-dicts$/ && do {
2907                 $PROFdicts = '-fauto-sccs-on-dicts';
2908                 next arg; };
2909     /^-auto-all$/ && do {
2910                 $PROFauto = '-fauto-sccs-on-all-toplevs';
2911                 next arg; };
2912     /^-auto$/ && do {
2913                 $PROFauto = '-fauto-sccs-on-exported-toplevs';
2914                 next arg; };
2915
2916     /^-caf-all/ && do { # generate individual CAF SCC annotations
2917                 $PROFcaf = '-fauto-sccs-on-individual-cafs';
2918                 next arg; };
2919
2920     /^-ignore-scc$/ && do {
2921                 # forces ignore of scc annotations even if profiling
2922                 $PROFignore_scc = '-W';
2923                 next arg; };
2924
2925     /^-G(.*)$/  && do { push(@HsC_flags, "-G=$1");   # set group for cost centres
2926                         next arg; };
2927
2928     /^-unprof-scc-auto/ && do {
2929                 # generate auto SCCs on top level bindings when not profiling.
2930                 # Used to measure optimisation effects of presence of sccs.
2931                 $UNPROFscc_auto = ( /-all/ )
2932                             ? '-fauto-sccs-on-all-toplevs'
2933                             : '-fauto-sccs-on-exported-toplevs';
2934                 next arg; };
2935
2936     #--------- ticky/parallel ----------------------------------------------
2937     # we sort out the details a bit later on
2938
2939     /^-gransim$/    && do { $GRANing   = 'g'; &add_syslib('concurrent'); next arg; }; # GranSim
2940     /^-ticky$/      && do { $TICKYing  = 't'; next arg; }; # ticky-ticky
2941     /^-parallel$/   && do { $PARing    = 'p'; &add_syslib('concurrent'); next arg; }; # parallel Haskell
2942
2943     #-------------- "user ways" --------------------------------------------
2944
2945     (/^-user-setup-([a-oA-Z])$/ ) && 
2946            do {
2947                 /^-user-setup-([a-oA-Z])$/  && do { $BuildTag = "_$1"; };
2948
2949                 local($stuff) = $UserSetupOpts{$BuildTag};
2950                 local(@opts)  = split(/\s+/, $stuff);
2951                 
2952                 # feed relevant ops into the arg-processing loop (if any)
2953                 unshift(@Args, @opts) if $#opts >= 0;
2954
2955                 next arg; };
2956
2957     #---------- set search paths for libraries and things ------------------
2958
2959     # we do -i just like HBC (-i clears the list; -i<colon-separated-items>
2960     # prepends the items to the list); -I is for including C .h files.
2961
2962     /^-i$/          && do { @Import_dir = ();  # import path cleared!
2963                             @SysImport_dir = ();
2964                             print STDERR "WARNING: import paths cleared by `-i'\n";
2965                             next arg; };
2966
2967     /^-i(.*)/       && do { local(@new_items)
2968                               = split( /:/, &grab_arg_arg(*Args,'-i', $1));
2969                             unshift(@Import_dir, @new_items);
2970                             next arg; };
2971
2972     /^-I(.*)/       && do { push(@Include_dir,     &grab_arg_arg(*Args,'-I', $1)); next arg; };
2973     /^-L(.*)/       && do { push(@UserLibrary_dir, &grab_arg_arg(*Args,'-L', $1)); next arg; };
2974     /^-l(.*)/       && do { push(@UserLibrary,'-l'.&grab_arg_arg(*Args,'-l', $1)); next arg; };
2975
2976     /^-syslib(.*)/  && do { local($syslib) = &grab_arg_arg(*Args,'-syslib',$1);
2977                             &add_syslib($syslib);
2978                             next arg; };
2979
2980     #=======================================================================
2981     # various flags that we can harmlessly send to one program or another
2982     # (we will later "reclaim" some of the compiler ones now sent to gcc)
2983     #=======================================================================
2984
2985     #---------- this driver itself (ghc) -----------------------------------
2986     # these change what executable is run for each phase:
2987     /^-pgmL(.*)$/   && do { $Unlit      = $1; next arg; };
2988     /^-pgmP(.*)$/   && do { $HsCpp      = $1; next arg; };
2989     /^-pgmC(.*)$/   && do { $HsC        = $1; next arg; };
2990     /^-pgmcO?(.*)$/ && do { $CcRegd     = $1; next arg; }; # the O? for back compat
2991     /^-pgma(.*)$/   && do { $As         = $1; next arg; };
2992     /^-pgml(.*)$/   && do { $Lnkr       = $1; next arg; };
2993     /^-pgmdep(.*)$/ && do { $MkDependHS = $1; next arg; };
2994
2995     #---------- the get-anything-through opts (all pgms) -------------------
2996     # these allow arbitrary option-strings to go to any phase:
2997     /^-optL(.*)$/   && do { push(@Unlit_flags,      $1); next arg; };
2998     /^-optP(.*)$/   && do { push(@HsCpp_flags,      $1); next arg; };
2999     /^-optCrts(.*)$/&& do { push(@HsC_rts_flags,    $1); next arg; };
3000     /^-optC(.*)$/   && do { push(@HsC_flags,        $1); next arg; };
3001     /^-optcpp(.*)$/ && do { push(@Cpp_define,       $1); $Only_preprocess_hc = ($1 eq "-E"); next arg; };
3002     /^-optc(.*)$/   && do { push(@CcBoth_flags,     $1); next arg; };
3003     /^-opta(.*)$/   && do { push(@As_flags,         $1); next arg; };
3004     /^-optl(.*)$/   && do { push(@Ld_flags,         $1); next arg; };
3005     /^-optdll(.*)$/ && do { push(@Dll_flags,        $1); next arg; };
3006     /^-optdep(.*)$/ && do { push(@MkDependHS_flags, $1); next arg; };
3007
3008     #---------- Haskell C pre-processor (hscpp) ----------------------------
3009     /^-D(.*)/       && do { push(@HsCpp_flags, "'-D".&grab_arg_arg(*Args,'-D',$1)."'"); next arg; };
3010     /^-U(.*)/       && do { push(@HsCpp_flags, "'-U".&grab_arg_arg(*Args,'-U',$1)."'"); next arg; };
3011
3012     #---------- post-Haskell "assembler"------------------------------------
3013     /^-ddump-raw-asm$/            && do { $Dump_raw_asm        = 1; next arg; };
3014     /^-ddump-asm-splitting-info$/ && do { $Dump_asm_splitting_info = 1; next arg; };
3015
3016     #---------- Haskell compiler (hsc) -------------------------------------
3017
3018     /^-keep-hc-files?-too$/     && do { $Keep_hc_file_too = 1; next arg; };
3019     /^-keep-s-files?-too$/      && do { $Keep_s_file_too = 1;  next arg; };
3020
3021     /^-fignore-interface-pragmas$/ && do { push(@HsC_flags, $_); next arg; };
3022     /^-fignore-asserts$/           && do { push(@HsC_flags, $_); next arg; };
3023
3024     /^-fno-implicit-prelude$/      && do { $NoImplicitPrelude= 1; push(@HsC_flags, $_); next arg; };
3025
3026      #
3027      # have the compiler proper generate concurrent code,
3028      # really only used when you want to configure your own
3029      # special user compilation way.
3030      #
3031      # (ditto for -fgransim, fscc-profiling, -fparallel and -fticky-ticky)
3032      #
3033     /^-fscc-profiling$/   && do { push(@HsC_flags,$_); next arg; };
3034     /^-fticky-ticky$/     && do { push(@HsC_flags,$_); next arg; };
3035     /^-fgransim$/         && do { push(@HsC_flags,$_); next arg; };
3036     /^-fparallel$/        && do { push(@HsC_flags,$_); next arg; };
3037
3038     /^-split-objs$/     && do {
3039                         if ( $TargetPlatform !~ /^(alpha|hppa1\.1|i386|m68k|mips|powerpc|rs6000|sparc)-/ ) {
3040                             $SplitObjFiles = 0;
3041                             print STDERR "WARNING: don't know how to split objects on this platform: $TargetPlatform\n`-split-objs' option ignored\n";
3042                         } else {
3043                             $SplitObjFiles = 1;
3044                             $HscOut = '-C=';
3045
3046                             push(@HsC_flags, "-fglobalise-toplev-names"); 
3047                             push(@CcBoth_flags, '-DUSE_SPLIT_MARKERS');
3048
3049                             require('ghc-split.prl')
3050                              || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-split.prl!\n");
3051                         }
3052                         next arg; };
3053
3054     /^-unreg$/              && do { $UNREGing = 'u'; next arg; };
3055     /^-funregisterised$/    && do { push(@HsC_flags, $_); next arg; };
3056     /^-fno-asm-mangling$/   && do { $DoAsmMangling = 0; next arg; };
3057
3058     /^-fallow-overlapping-instances$/ && do { push(@HsC_flags, $_); next arg; };
3059     /^-fallow-undecidable-instances$/ && do { push(@HsC_flags, $_); next arg; };
3060     /^-fhistory-size.*$/              && do { push(@HsC_flags, $_); next arg; };
3061     /^-fglasgow-exts$/
3062                 && do { push(@HsC_flags, $_);
3063
3064                         # -fglasgow-exts implies -syslib exts
3065                         &add_syslib('exts');
3066
3067                         next arg; };
3068
3069     /^-fspeciali[sz]e$/
3070                 && do { $Oopt_DoSpecialise = '-fspecialise'; next arg; };
3071     /^-fno-speciali[sz]e$/
3072                 && do { $Oopt_DoSpecialise = ''; next arg; };
3073
3074     /^-fusagesp$/
3075                 && do {  $Oopt_UsageSPInf = '-fusagesp';
3076                          push (@HsC_flags, '-fusagesp-on'); next arg; };
3077
3078     /^-fcompiling-prelude$/ && do { $CompilingPrelude=1; push(@HsC_flags, $_); next arg; };
3079
3080 # Now the foldr/build options, which are *on* by default (for -O).
3081
3082     /^-ffoldr-build$/
3083                     && do { $Oopt_FoldrBuild = 1; 
3084                             #print "Yes F/B\n";
3085                             next arg; };
3086
3087     /^-fno-foldr-build$/
3088                     && do { $Oopt_FoldrBuild = 0; 
3089                             next arg; };
3090
3091     # --------------- Renamer -------------
3092
3093
3094     /^-fno-prune-tydecls$/     && do { push(@HsC_flags, $_); next arg; };
3095     /^-fno-prune-instdecls$/     && do { push(@HsC_flags, $_); next arg; };
3096
3097     # ---------------
3098
3099     /^-fasm-(.*)$/  && do { $HscOut = '-S='; next arg; }; # force using nativeGen
3100     /^-fvia-[cC]$/          && do { $HscOut = '-C='; next arg; }; # force using C compiler
3101
3102     # ---------------
3103
3104     /^-funfolding-.*$/
3105                     && do { push(@HsC_flags, $_); next arg };
3106
3107     /^-funfold-casms-in-hi-file$/
3108                     && do { push(@HsC_flags, $_); next arg };
3109
3110     /^(-fmax-simplifier-iterations)(.*)$/
3111                     && do { $Oopt_MaxSimplifierIterations = $1 . &grab_arg_arg(*Args,$1, $2);
3112                             next arg; };
3113
3114     /^-fno-pedantic-bottoms$/
3115                     && do { $Oopt_PedanticBottoms = ''; next arg; };
3116
3117     /^-fno-pre-inlining$/
3118                     && do { push(@HsC_flags, $_); next arg };
3119
3120     /^-fno-let-from-(case|app|strict-let)$/ # experimental, really (WDP 95/10)
3121                     && do { push(@HsC_flags, $_); next arg; };
3122
3123     /^-funbox-strict-fields$/
3124                    && do { push(@HsC_flags, $_); next arg; };
3125
3126     # --------------- Warnings etc. ------
3127
3128     /^-fwarn-(.*)$/      && do { push(@HsC_flags, $_); next arg; };
3129
3130     /^-fno-(.*)$/   && do { push(@HsC_antiflags, "-f$1");
3131                             &squashHscFlag("-f$1");
3132                             next arg; };
3133
3134     /^-W$/          && do { push(@HsC_flags, @MinusWOpts); next arg; };
3135     /^-Wall$/       && do { push(@HsC_flags, @MinusWallOpts); next arg; };
3136     /^(-Wnot|w)$/   && do { foreach (@Hsc_flags) {
3137                                 /^-fwarn-(.*)$/ && do { $_=''; };
3138                             };
3139                             push(@HsC_antiflags, @StandardWarnings);
3140                             next arg; };
3141
3142     # --------------- fun stuff ----------------
3143
3144     /^-freport-compile$/ && do { push(@HsC_flags, $_); next arg; };
3145
3146     # --------------- platform specific flags (for gcc mostly) ----------------
3147
3148     /^-mlong-calls$/ && do { # for GCC for HP-PA boxes,
3149                              # for 2.6.x..?, does not apply for 2.7.2
3150                              # any longer.
3151                             unshift(@CcBoth_flags, ( $_ ));
3152                             next arg; };
3153
3154     /^-m(v8|sparclite|cypress|supersparc|cpu=(cypress|supersparc))$/
3155                      && do { # for GCC for SPARCs
3156                             unshift(@CcBoth_flags, ( $_ ));
3157                             next arg; };
3158
3159     /^-monly-([432])-regs/ && do { # for iX86 boxes only; no effect otherwise
3160                             $StolenX86Regs = $1;
3161                             next arg; };
3162
3163     #*************** ... and lots of debugging ones (form: -d* )
3164
3165     # -d(no-)core-lint is done this way so it is turn-off-able.
3166     /^-dcore-lint/       && do { $CoreLint = '-dcore-lint'; next arg; };
3167     /^-dno-core-lint/    && do { $CoreLint = '';            next arg; };
3168     # Ditto for USP lint
3169     /^-dusagesp-lint/    && do { $USPLint = '-dusagesp-lint'; next arg; };
3170     /^-dno-usagesp-lint/ && do { $USPLint = '';               next arg; };
3171     # Ditto for STG lint
3172     /^-dstg-lint/       && do { $StgLint = '-dstg-lint'; next arg; };
3173     /^-dno-stg-lint/    && do { $StgLint = '';           next arg; };
3174
3175     /^-d(dump|ppr)-/         && do { push(@HsC_flags, $_); next arg; };
3176     /^-dverbose-(simpl|stg)/ && do { push(@HsC_flags, $_); next arg; };
3177     /^-dshow-passes/         && do { push(@HsC_flags, $_); next arg; };
3178     /^-dshow-rn-stats/       && do { push(@HsC_flags, $_); next arg; };
3179     /^-dshow-rn-trace/       && do { push(@HsC_flags, $_); next arg; };
3180     /^-dsource-stats/        && do { push(@HsC_flags, $_); next arg; };
3181     /^-dsimplifier-stats/    && do { push(@HsC_flags, $_); next arg; };
3182     /^-dstg-stats/           && do { $Oopt_StgStats = $_; next arg; };
3183
3184     #*************** ... and now all these -R* ones for its runtime system...
3185
3186     /^-Rscale-sizes?(.*)/ && do {
3187         $Scale_sizes_by = &grab_arg_arg(*Args,'-Rscale-sizes', $1);
3188         next arg; };
3189
3190     /^(-H|-Rmax-heapsize)(.*)/ && do {
3191         local($heap_size) = &grab_arg_arg(*Args,$1, $2);
3192         if ($heap_size =~ /(\d+)[Kk]$/) {
3193             $heap_size = $1 * 1000;
3194         } elsif ($heap_size =~ /(\d+)[Mm]$/) {
3195             $heap_size = $1 * 1000 * 1000;
3196         } elsif ($heap_size =~ /(\d+)[Gg]$/) {
3197             $heap_size = $1 * 1000 * 1000 * 1000;
3198         }
3199         if ($heap_size <= 0) {
3200             print STDERR "$Pgm: resetting heap-size to zero!!! $heap_size\n";
3201             $Specific_heap_size = 0;
3202         
3203         # if several heap sizes given, take the largest...
3204         } elsif ($heap_size >= $Specific_heap_size) {
3205             $Specific_heap_size = $heap_size;
3206         } else {
3207             print STDERR "$Pgm: ignoring heap-size-setting option ($_)...not the largest seen\n";
3208         }
3209         next arg; };
3210
3211     /^(-K|Rmax-(stk|stack)size)(.*)/ && do {
3212         local($flag) = $1;
3213         local($stk_size) = &grab_arg_arg(*Args,'-Rmax-stksize', $3);
3214         if ($stk_size =~ /(\d+)[Kk]$/) {
3215             $stk_size = $1 * 1000;
3216         } elsif ($stk_size =~ /(\d+)[Mm]$/) {
3217             $stk_size = $1 * 1000 * 1000;
3218         } elsif ($stk_size =~ /(\d+)[Gg]$/) {
3219             $stk_size = $1 * 1000 * 1000 * 1000;
3220         }
3221         if ($stk_size <= 0) {
3222             print STDERR "$Pgm: resetting stack-size to zero!!! $stk_size\n";
3223             $Specific_stk_size = 0;
3224
3225         # if several stack sizes given, take the largest...
3226         } elsif ($stk_size >= $Specific_stk_size) {
3227             $Specific_stk_size = $stk_size;
3228         } else {
3229             print STDERR "$Pgm: ignoring stack-size-setting option ($flag $stk_size)...not the largest seen\n";
3230         }
3231         next arg; };
3232
3233     /^-Rgc-stats$/ && do {  $CollectingGCstats++;
3234                             # the two RTSs do this diff ways; we will try to compensate
3235                             next arg; };
3236
3237     /^-Rghc-timing/ && do { $CollectGhcTimings = 1; next arg; };
3238
3239     #---------- C high-level assembler (gcc) -------------------------------
3240     /^-(Wall|ansi|pedantic)$/ && do { push(@CcBoth_flags, $_); next arg; };
3241
3242     # -dgcc-lint is a useful way of making GCC very fussy.
3243     # From alan@spri.levels.unisa.edu.au (Alan Modra).
3244     /^-dgcc-lint$/ && do { push(@CcBoth_flags, '-Wall -Wpointer-arith -Wbad-function-cast -Wcast-qual -Wstrict-prototypes -Wmissing-prototypes -Wmissing-declarations -Wnested-externs'); next arg; };
3245     # An alternate set, from mark@sgcs.com (Mark W. Snitily)
3246     # -Wall -Wstrict-prototypes -Wmissing-prototypes -Wcast-align -Wshadow
3247
3248     # inject "#include <wurble>" into the compiler's C output!
3249
3250     /^-#include(.*)/    && do {
3251         local($to_include) = &grab_arg_arg(*Args,'-#include', $1);
3252         push(@CcInjects, "#include $to_include\n");
3253         next arg; };
3254
3255     #---------- Linker (gcc, really) ---------------------------------------
3256
3257     /^-static$/         && do { $Static=1; push(@Ld_flags, $_); next arg; };
3258     /^-no-hs-main$/     && do { $NoHaskellMain=1; next arg;    };
3259
3260     #---------- mixed cc and linker magic ----------------------------------
3261     # this optimisation stuff is finally sorted out later on...
3262
3263     /^-O2-for-C$/ && do { $MinusO2ForC = 1; next arg; };
3264
3265     /^-O[1-2]?$/ && do {
3266                 local($opt_lev) = ( /^-O2$/ ) ? 2 : 1; # max 'em
3267                 $OptLevel = ( $opt_lev > $OptLevel ) ? $opt_lev : $OptLevel;
3268
3269                 $HscOut = '-C=' if $OptLevel == 2; # force use of C compiler
3270                 next arg; };
3271
3272     /^-Onot$/   && do { $OptLevel = 0; next arg; }; # # set it to <no opt>
3273
3274     /^-Ofile(.*)/ && do {
3275                 $OptLevel = 3;
3276                 local($ofile) = &grab_arg_arg(*Args,'-Ofile', $1);
3277                 @HsC_minusO3_flags = ();
3278
3279                 open(OFILE, "< $ofile") || die "Can't open $ofile!\n";
3280                 while (<OFILE>) {
3281                     chop;
3282                     s/\#.*//;       # death to comments
3283                     s/[ \t]+//g;    # death to whitespace
3284                     next if /^$/;   # ditto, blank lines
3285                     s/([()*{}])/\\$1/g;    # protect shell metacharacters
3286                     if ( /^C:(.*)/ ) {
3287                         push(@CcBoth_flags, $1);
3288                     } else {
3289                         push(@HsC_minusO3_flags, $_);
3290                     }
3291                 }
3292                 close(OFILE);
3293                 next arg; };
3294
3295     /^-debug$/  && do { # all this does is mark a .hc/.o as "debugging"
3296                         # in the consistency info
3297                         $DEBUGging = 'd';
3298                         next arg; };
3299
3300     #---------- linking .a file --------------------------------------------
3301
3302     /^-Main(.*)/ && do {
3303                 # specifies main or mainPrimIO to be linked
3304                 $Ld_main = $1;
3305                 next arg; }; 
3306
3307     #---------- catch unrecognized flags -----------------------------------
3308
3309     /^-./ && do {
3310         print STDERR "$Pgm: unrecognised option: $_\n";
3311         $Status++;
3312         next arg; };
3313
3314 }
3315
3316 } # end of processArgs
3317
3318 \end{code}