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