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