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