ghc/driver/ghc.lprl

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