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