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