ghc/driver/ghc.lprl

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