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