ghc/driver/ghc.lprl

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