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