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