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