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