ghc/driver/ghc.lprl

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