ghc/driver/ghc.lprl

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