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          $Specific_output_file = 'main.exe';
1865          print STDERR "Output file not specified, defaulting to \"main.exe\"\n";
1866     }
1867
1868     local($output) = ($Specific_output_file ne '') ? "-o $Specific_output_file" : '';
1869     @Files_to_tidy = ($Specific_output_file ne '') ? $Specific_output_file : 'a.out';
1870
1871     &prepareWin32DllLink(1);
1872
1873     local($to_do) = "$lnkr $Verbose @Ld_flags $output @Link_file $libdirs @UserLibrary @SysLibrary";
1874     &run_something($to_do, 'Linker');
1875
1876     # finally, check the consistency info in the binary
1877     local($executable) = $Files_to_tidy[0];
1878     @Files_to_tidy = (); # reset; we don't want to nuke it if it's inconsistent
1879
1880     if ( $LinkChk ) {
1881         # dynamically load consistency-chking code; then do it.
1882         require('ghc-consist.prl')
1883             || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-consist.prl!\n");
1884
1885         &chk_consistency_info ( $executable );
1886     }
1887
1888     # if PVM parallel stuff, we do truly weird things.
1889     # Essentially: (1) move the executable over to where PVM expects
1890     # to find it.  (2) create a script in place of the executable
1891     # which will cause the program to be run, via SysMan.
1892     if ( $PARing eq 'p' ) {
1893         local($pvm_executable) = $executable;
1894         local($pvm_executable_base);
1895
1896         if ( $pvm_executable !~ /^\// ) { # a relative path name: make absolute
1897             local($pwd) = `pwd`;
1898             chop($pwd);
1899             $pwd =~ s/^\/tmp_mnt//;
1900             $pvm_executable = "$pwd/$pvm_executable";
1901         }
1902
1903         $pvm_executable =~ s|/|=|g; # make /s into =s
1904         $pvm_executable_base = $pvm_executable;
1905
1906         $pvm_executable = $ENV{'PVM_ROOT'} . '/bin/' . $ENV{'PVM_ARCH'}
1907                         . "/$pvm_executable";
1908
1909         &run_something("$Rm -f $pvm_executable; $Cp -p $executable $pvm_executable && $Rm -f $executable", 'Moving binary to PVM land');
1910
1911         # OK, now create the magic script for "$executable"
1912         open(EXEC, "> $executable") || &tidy_up_and_die(1,"$Pgm: couldn't open $executable to write!\n");
1913         print EXEC <<EOSCRIPT1;
1914 eval 'exec perl -S \$0 \${1+"\$@"}'
1915   if \$running_under_some_shell;
1916 # =!=!=!=!=!=!=!=!=!=!=!
1917 # This script is automatically generated: DO NOT EDIT!!!
1918 # Generated by Glasgow Haskell, version ${ProjectVersion}
1919 # ngoqvam choHbogh vaj' vIHoHnISbej !!!!
1920 #
1921 \$pvm_executable      = '$pvm_executable';
1922 \$pvm_executable_base = '$pvm_executable_base';
1923 \$SysMan = '$SysMan';
1924 EOSCRIPT1
1925
1926         print EXEC <<\EOSCRIPT2;
1927 # first, some magical shortcuts to run "commands" on the binary
1928 # (which is hidden)
1929 if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {
1930     local($cmd) = $1;
1931     system("$cmd $pvm_executable");
1932     exit(0); # all done
1933 }
1934
1935 # OK, really run it; process the args first
1936 $ENV{'PE'} = $pvm_executable_base;
1937 $debug = '';
1938 $nprocessors = 2; # the default
1939 @nonPVM_args = ();
1940 $in_RTS_args = 0;
1941
1942 # ToDo: handle --RTS
1943 args: while ($a = shift(@ARGV)) {
1944     if ( $a eq '+RTS' ) {
1945         $in_RTS_args = 1;
1946     } elsif ( $a eq '-RTS' ) {
1947         $in_RTS_args = 0;
1948     }
1949     if ( $a eq '-d' && $in_RTS_args ) {
1950         $debug = '-';
1951     } elsif ( $a =~ /^-qN(\d+)/ && $in_RTS_args ) {
1952         $nprocessors = $1;
1953     } elsif ( $a =~ /^-qp(\d+)/ && $in_RTS_args ) {
1954         $nprocessors = $1;
1955     } else {
1956         push(@nonPVM_args, $a);
1957     }
1958 }
1959
1960 local($return_val) = 0;
1961 system("$SysMan $debug $pvm_executable $nprocessors @nonPVM_args");
1962 $return_val = $?;
1963 system("mv $ENV{'HOME'}/$pvm_executable_base.???.gr .") if -f "$ENV{'HOME'}/$pvm_executable_base.001.gr";
1964 exit($return_val);
1965 EOSCRIPT2
1966         close(EXEC) || die "Failed closing $executable\n";
1967         chmod 0755, $executable;
1968     }
1969 }
1970
1971 sub createWin32DLL
1972 {
1973     local ($libdirs);
1974
1975     # append last minute flags linker and consistency flags
1976     &setupBuildFlags();
1977     &setupSyslibs();
1978     &setupLinkOpts();
1979
1980     # glue them together:
1981     push(@UserLibrary_dir, @SysLibrary_dir);
1982
1983     $libdirs = '-L' . join(' -L',@UserLibrary_dir) if $#UserLibrary_dir >= 0;
1984
1985     &prepareWin32DllLink(0);
1986
1987     local ($bld_dll) = "dllwrap";
1988
1989     local ($output) = ($Specific_output_file ne '') ? "$Specific_output_file" : 'HSdll.dll';
1990     local ($output_dir);
1991     local ($output_file);
1992     local ($output_lib, $output_def);
1993
1994     ($output_dir = $output) =~ s|(.*/)[^/]+$|$1|;
1995     $output_dir = "" if ($output_dir eq $output);
1996     ($output_file = $output) =~ s|.*/([^/]+)$|$1|;
1997
1998     ($output_lib = $output_file) =~ s|(.+)\.[^\.]*$|${output_dir}lib$1_imp.a|;
1999     ($output_def = $output_file) =~ s|(.+)\.[^\.]*$|${output_dir}$1.def|;
2000
2001     push (@Dll_flags, "-mno-cygwin --target=i386-mingw32") if ($TargetPlatform =~ /^.*mingw32$/);
2002     push (@Dll_flags, "--output-lib $output_lib");
2003     # If the "--def " option hasn't been supplied, assume everything
2004     # is going to be exported via the DLL.."
2005     if (!grep(/--def/, @Dll_flags)) {
2006       push (@Dll_flags, "--export-all --output-def $output_def");
2007     }
2008
2009     local($to_do) = "$bld_dll @Dll_flags -o $output @Link_file $libdirs @UserLibrary @SysLibrary";
2010     # Make sure the user sees this piece of magic.
2011     print STDERR "$to_do\n" if (!$Verbose);
2012     &run_something($to_do, 'DLL creator');
2013 }
2014
2015 sub prepareWin32DllLink
2016 {
2017     local($linking_main) = @_;
2018
2019     #
2020     # Win32 DLLs - link with import libraries, not the real archives.
2021     #
2022     if ( $TargetPlatform =~ /-mingw32$/ ) {
2023        if (!$Static) {
2024          #
2025          # If the libraries have the form libHSfoo.a, we
2026          # transform that into libHSfoo_imp.a - the import
2027          # library of the DLL.
2028          #
2029          foreach $a ( @SysLibrary ) {
2030            $a = "${a}_imp" if ($a =~ /^-lHS/);
2031          }
2032          foreach $a ( @UserLibrary ) {
2033            $a = "${a}_imp" if ($a =~ /^-lHS/);
2034          }
2035          push(@Link_file, ( $INSTALLING ) ? "$InstLibDirGhc/Main.dll_o"
2036                                           : "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR/Main.dll_o") if $linking_main;
2037          push(@Link_file, ( $INSTALLING ) ? "$InstLibDirGhc/PrelMain.dll_o"
2038                                           : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/std/PrelMain.dll_o") if $linking_main;
2039        }
2040        push(@Ld_flags,  "-mno-cygwin");
2041     }
2042 }
2043 \end{code}
2044
2045
2046 %************************************************************************
2047 %*                                                                      *
2048 \section[Driver-misc-utils]{Miscellaneous utilities}
2049 %*                                                                      *
2050 %************************************************************************
2051
2052 %************************************************************************
2053 %*                                                                      *
2054 \subsection[Driver-odir-ify]{@odir_ify@: Mangle filename if \tr{-odir} set}
2055 %*                                                                      *
2056 %************************************************************************
2057
2058 \begin{code}
2059 sub osuf_ify {
2060     local($ofile,$def_suffix) = @_;
2061
2062     return(($Osuffix eq '') ? "$ofile.$def_suffix" : "$ofile.$Osuffix" );
2063 }
2064
2065 sub odir_ify {
2066     local($orig_file, $def_suffix) = @_;
2067     if ($Specific_output_dir eq '') {   # do nothing
2068         &osuf_ify($orig_file, $def_suffix);
2069     } else {
2070         local ($orig_file_only);
2071         ($orig_file_only = $orig_file) =~ s|.*/||;
2072         &osuf_ify("$Specific_output_dir/$orig_file_only",$def_suffix);
2073     }
2074 }
2075 \end{code}
2076
2077 \begin{code}
2078 sub runGcc {
2079     local($is_hc_file, $hsc_out, $cc_as_o) = @_;
2080
2081     local($includes) = '-I' . join(' -I', @Include_dir);
2082     local($cc);
2083     local($s_output);
2084     local($c_flags) = "@CcBoth_flags";
2085     local($ddebug_flag) = ( $DEBUGging ) ? '-DDEBUG' : '';
2086
2087     $c_flags .= " -mno-cygwin" if ( $TargetPlatform =~ /-mingw32$/ );
2088
2089     # "input" files to use that are not in some weird directory;
2090     # to help C compilers grok .hc files [ToDo: de-hackify]
2091     local($cc_help)   = "ghc$$.c";
2092     local($cc_help_s) = "ghc$$.s";
2093
2094     $cc       = $CcRegd;
2095     $s_output = (($is_hc_file && $DoAsmMangling) || $TargetPlatform =~ /^(powerpc|rs6000|hppa)/) ? $cc_as_o : $cc_as;
2096     $c_flags .= " @CcRegd_flags";
2097     $c_flags .= ($is_hc_file) ? " @CcRegd_flags_hc"  : " @CcRegd_flags_c";
2098
2099     # C compiler won't like the .hc extension.  So we create
2100     # a tmp .c file which #include's the needful.
2101     open(TMP, "> $cc_help") || &tidy_up_and_die(1,"$Pgm: failed to open `$cc_help' (to write)\n");
2102     if ( $is_hc_file ) {
2103         print TMP <<EOINCL;
2104 #include "Stg.h"
2105 EOINCL
2106         # user may have asked for #includes to be injected...
2107         print TMP @CcInjects if $#CcInjects >= 0;
2108     } else {
2109         # Straight .c files may want to know that they're being used
2110         # with a particular version of GHC, so we define __GLASGOW_HASKELL__ for their benefit.
2111         print TMP "#define __GLASGOW_HASKELL__ ${ProjectVersionInt}\n";
2112     }
2113     # heave in the consistency info
2114     print TMP "static char ghc_cc_ID[] = \"\@(#)cc $ifile\t$Cc_major_version.$Cc_minor_version,$Cc_consist_options\";\n";
2115
2116     print TMP "#include \"$hsc_out\"\n";
2117     close(TMP) || &tidy_up_and_die(1,"Failed writing to $cc_help\n");
2118
2119     # Don't redirect stderr into intermediate file if slamming output onto stdout (e.g., with -E)
2120     local($fuse_stderr) = "2>&1" if ! $Only_preprocess_hc;
2121     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 )";
2122
2123     if ( $Only_preprocess_hc ) { # HACK ALERT!
2124         $to_do =~ s/ -S\b//g;
2125     }
2126     push(@Files_to_tidy, $cc_help, $cc_help_s, $s_output );
2127     $PostprocessCcOutput = 1 if ! $Only_preprocess_hc;  # hack, dear hack...
2128     &run_something($to_do, 'C compiler');
2129     $PostprocessCcOutput = 0;
2130     if ( $Only_preprocess_hc ) {
2131        system("$Cat $Tmp_prefix.ccout");
2132     }
2133     unlink($cc_help, $cc_help_s);
2134 }
2135 \end{code}
2136
2137 \begin{code}
2138 sub runMangler {
2139     local($is_hc_file, $cc_as_o, $cc_as, $ifile_root) = @_;
2140
2141     print STDERR `cat $cc_as_o` if $Dump_raw_asm; # to stderr, before mangling
2142
2143     if ($is_hc_file && $DoAsmMangling) {
2144         # dynamically load assembler-fiddling code, which we are about to use:
2145         require('ghc-asm.prl')
2146              || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm.prl!\n");
2147         # post-process the assembler [.hc files only]
2148         &mangle_asm($cc_as_o, $cc_as);
2149
2150     } elsif ($TargetPlatform =~ /^hppa/) {
2151         # minor mangling of non-threaded files for hp-pa only
2152         require('ghc-asm.prl')
2153         || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-hppa.prl!\n");
2154         &mini_mangle_asm_hppa($cc_as_o, $cc_as);
2155
2156     } elsif ($TargetPlatform =~ /^powerpc|^rs6000/) {
2157         # minor mangling of non-threaded files for powerpcs and rs6000s
2158         require('ghc-asm.prl')
2159         || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-powerpc.prl!\n");
2160         &mini_mangle_asm_powerpc($cc_as_o, $cc_as);
2161     }
2162
2163     # save a copy of the .s file, even if we are carrying on...
2164     #if ($do_as && $Keep_s_file_too) {
2165     #    &saveIntermediate($ifile_root , "s" , $cc_as);
2166     #}
2167 }
2168 \end{code}
2169
2170 \begin{code}
2171 sub runAs {
2172     local($as_out, $ifile_root) = @_;
2173
2174     local($asmblr) = ( $As ) ? $As : $CcRegd;
2175
2176     # need to add the -I flags in case the file is going through cpp (.S files)
2177     local($includes) = '-I' . join(' -I', @Include_dir);
2178
2179    if ( ! $SplitObjFiles || $ifile_root =~ /_stub\.s$/ ) {
2180         local($to_do)  = "$asmblr -o $as_out -c @As_flags $includes $cc_as";
2181         push(@Files_to_tidy, $as_out );
2182         &run_something($to_do, 'Unix assembler');
2183
2184     } else { # more complicated split-ification...
2185
2186         # must assemble files $Tmp_prefix__[1 .. $NoOfSplitFiles].s
2187
2188         # If -odir is used, great, just pin it in front of the
2189         # generated split file names. If it hasn't been set, we
2190         # snatch it from the ifile_root.
2191         #
2192         #
2193
2194         if ( $Specific_output_dir eq '' ) {
2195             $Specific_output_dir = ${ifile_root};
2196         }
2197
2198         for ($f = 1; $f <= $NoOfSplitFiles; $f++ ) {
2199             local($split_out) = &odir_ify("${ifile_root}__${f}",'o');
2200             local($to_do) = "$asmblr -o $split_out -c @As_flags ${Tmp_prefix}__${f}.s";
2201             push(@Files_to_tidy, $split_out );
2202
2203             &run_something($to_do, 'Unix assembler');
2204         }
2205     }
2206 }
2207 \end{code}
2208
2209 %************************************************************************
2210 %*                                                                      *
2211 \subsection[Driver-run-something]{@run_something@: Run a phase}
2212 %*                                                                      *
2213 %************************************************************************
2214
2215 \begin{code}
2216 sub run_something {
2217     local($str_to_do, $tidy_name) = @_;
2218
2219     print STDERR "\n$tidy_name:\n\t" if $Verbose;
2220     print STDERR "$str_to_do\n" if $Verbose;
2221
2222     if ($Using_dump_file) {
2223         open(DUMP, ">> $Specific_dump_file")
2224             || &tidy_up_and_die(1,"$Pgm: failed to open `$Specific_dump_file'\n");
2225         print DUMP "\nCompilation Dump for: $str_to_do\n\n";
2226         close(DUMP)
2227             || &tidy_up_and_die(1,"$Pgm: failed closing `$Specific_dump_file'\n");
2228     }
2229
2230     local($return_val) = 0;
2231
2232     if ( length($str_to_do) > 4000) {
2233       # 4000 - on the random side, just like the *real* ARG_MAX
2234       # for some shells.
2235
2236       # With some shells, command lines of this length may
2237       # very well cause trouble. To safeguard against this, we squirrel the
2238       # command into a file and exec that.
2239       local ($sh) = $ENV{'REAL_SHELL'};
2240       print STDERR "Backup plan A: saving cmd line in ${Tmp_prefix}.sh and executing that with $sh\n" if $Verbose;
2241       open (TEMP, "> ${Tmp_prefix}.sh") ||
2242                 &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.sh'\n");
2243       print TEMP "$Time $str_to_do\n";
2244       close (TEMP) ||
2245                 &tidy_up_and_die(1,"$Pgm: failed closing `$Tmp_prefix.sh'\n");
2246       system("$sh $Tmp_prefix.sh");
2247       $return_val = $?;
2248
2249       unlink "${Tmp_prefix}.sh";
2250     } else {
2251       system("$Time $str_to_do");
2252       $return_val = $?;
2253     }
2254
2255     if ( $PostprocessCcOutput ) { # hack, continued
2256         open(CCOUT, "< $Tmp_prefix.ccout")
2257             || &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.ccout'\n");
2258         while ( <CCOUT> ) {
2259             next if /call-clobbered/;
2260             next if /control reaches end/;
2261             next if /from .*Stg\.h:/;
2262             next if /from ghc\d+.c:\d+:/;
2263             next if /: At top level:$/;
2264             next if /: In function \`.*\':$/;
2265             next if /\`ghc_cc_ID\' defined but not used/;
2266             print STDERR $_;
2267         }
2268         close(CCOUT) || &tidy_up_and_die(1,"$Pgm: failed closing `$Tmp_prefix.ccout'\n");
2269     }
2270
2271     local($signal_num)  = $? & 127;
2272     local($dumped_core) = $? & 128;
2273
2274     if ($signal_num != 0) {
2275         print STDERR "$tidy_name received signal $signal_num";
2276         if ($dumped_core != 0) {
2277                 print STDERR " (core dumped)";
2278         }
2279         print STDERR "\n";
2280     }
2281
2282     if ($return_val != 0) {
2283         if ($Using_dump_file) {
2284             print STDERR "Compilation Errors dumped in $Specific_dump_file\n";
2285         }
2286         &tidy_up_and_die($return_val, '');
2287     }
2288
2289     $Using_dump_file = 0;
2290 }
2291 \end{code}
2292
2293 %************************************************************************
2294 %*                                                                      *
2295 \subsection[Driver-ghc-timing]{Emit nofibbish GHC timings}
2296 %*                                                                      *
2297 %************************************************************************
2298
2299 NB: nearly the same as in @runstdtest@ script.
2300
2301 \begin{code}
2302 sub process_ghc_timings {
2303     local($StatsFile) = "$Tmp_prefix.stat";
2304     local($SysSpecificTiming) = 'ghc';
2305
2306     open(STATS, $StatsFile) || die "Failed when opening $StatsFile\n";
2307     local($max_live)    = 0;
2308     local($tot_live)    = 0; # for calculating residency stuff
2309     local($tot_samples) = 0;
2310
2311     while (<STATS>) {
2312         if (! /Gen:\s+0/ && ! /Minor/ && /^\s*\d+\s+\d+\s+(\d+)\s+\d+\.\d+/ ) {
2313                 $max_live = $1 if $max_live < $1;
2314                 $tot_live += $1;
2315                 $tot_samples += 1;
2316         }
2317         $BytesAlloc = $1 if /^\s*([0-9,]+) bytes allocated in the heap/;
2318
2319         if ( /^\s*([0-9,]+) bytes maximum residency .* (\d+) sample/ ) {
2320             $MaxResidency = $1; $ResidencySamples = $2;
2321         }
2322
2323         $GCs = $1 if /^\s*([0-9,]+) (collections? in generation 0|garbage collections? performed)/;
2324
2325         if ( /^\s+([0-9]+)\s+Mb total memory/ ) {
2326             $TotMem = $1;
2327         }
2328
2329         # The presence of -? in the following pattern is only there to
2330         # accommodate 0.29 && <= 2.05 RTS'
2331         if ( /^\s*INIT\s+time\s*(\d+\.\d\d)s\s*\(\s*-?(\d+\.\d\d)s elapsed\)/ ) {
2332             $InitTime = $1; $InitElapsed = $2;
2333         } elsif ( /^\s*MUT\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2334             $MutTime = $1; $MutElapsed = $2;
2335         } elsif ( /^\s*GC\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2336             $GcTime = $1; $GcElapsed = $2;
2337         }
2338     }
2339     close(STATS) || die "Failed when closing $StatsFile\n";
2340     if ( $tot_samples > 0 ) {
2341         $ResidencySamples = $tot_samples;
2342         $MaxResidency = $max_live;
2343         $AvgResidency = int ($tot_live / $tot_samples) ;
2344     }
2345
2346     # warn about what we didn't find
2347     print STDERR "Warning: BytesAlloc not found in stats file\n" unless defined($BytesAlloc);
2348     print STDERR "Warning: GCs not found in stats file\n" unless defined($GCs);
2349     print STDERR "Warning: InitTime not found in stats file\n" unless defined($InitTime);
2350     print STDERR "Warning: InitElapsed not found in stats file\n" unless defined($InitElapsed);
2351     print STDERR "Warning: MutTime not found in stats file\n" unless defined($MutTime);
2352     print STDERR "Warning: MutElapsed not found in stats file\n" unless defined($MutElapsed);
2353     print STDERR "Warning: GcTime inot found in stats file\n" unless defined($GcTime);
2354     print STDERR "Warning: GcElapsed not found in stats file\n" unless defined($GcElapsed);
2355
2356     # things we didn't necessarily expect to find
2357     $MaxResidency     = 0 unless defined($MaxResidency);
2358     $AvgResidency     = 0 unless defined($AvgResidency);
2359     $ResidencySamples = 0 unless defined($ResidencySamples);
2360
2361     # a bit of tidying
2362     $BytesAlloc =~ s/,//g;
2363     $MaxResidency =~ s/,//g;
2364     $GCs =~ s/,//g;
2365     $InitTime =~ s/,//g;
2366     $InitElapsed =~ s/,//g;
2367     $MutTime =~ s/,//g;
2368     $MutElapsed =~ s/,//g;
2369     $GcTime =~ s/,//g;
2370     $GcElapsed =~ s/,//g;
2371
2372     # print out what we found
2373     print STDERR "<<$SysSpecificTiming: ",
2374         "$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)",
2375         " :$SysSpecificTiming>>\n";
2376
2377     # OK, party over
2378     unlink $StatsFile;
2379 }
2380 \end{code}
2381
2382 %************************************************************************
2383 %*                                                                      *
2384 \subsection[Driver-dying]{@tidy_up@ and @tidy_up_and_die@: Dying gracefully}
2385 %*                                                                      *
2386 %************************************************************************
2387
2388 \begin{code}
2389 sub tidy_up {
2390     local($to_do) = "\n$Rm $Tmp_prefix*";
2391     if ( $Tmp_prefix !~ /^\s*$/ ) {
2392         print STDERR "$to_do\n" if $Verbose;
2393         system($to_do);
2394     }
2395 }
2396
2397 sub tidy_up_and_die {
2398     local($return_val, $msg) = @_;
2399
2400     # delete any files to tidy
2401     print STDERR "deleting... @Files_to_tidy\n" if $Verbose && $#Files_to_tidy >= 0;
2402     unlink @Files_to_tidy if $#Files_to_tidy >= 0;
2403
2404     &tidy_up();
2405     print STDERR $msg;
2406     exit (($return_val == 0) ? 0 : 1);
2407 }
2408 \end{code}
2409
2410 %************************************************************************
2411 %*                                                                      *
2412 \subsection[Driver-arg-with-arg]{@grab_arg_arg@: Do an argument with an argument}
2413 %*                                                                      *
2414 %************************************************************************
2415
2416 Some command-line arguments take an argument, e.g.,
2417 \tr{-Rmax-heapsize} expects a number to follow.  This can either be
2418 given a part of the same argument (\tr{-Rmax-heapsize8M}) or as the
2419 next argument (\tr{-Rmax-heapsize 8M}).  We allow both cases.
2420
2421 Note: no error-checking; \tr{-Rmax-heapsize -Rgc-stats} will silently
2422 gobble the second argument (and probably set the heapsize to something
2423 nonsensical).
2424 \begin{code}
2425 sub grab_arg_arg {
2426     local(*Args, $option, $rest_of_arg) = @_;
2427
2428     if ($rest_of_arg ne '') {
2429         return($rest_of_arg);
2430     } elsif ($#Args >= 0) {
2431         local($temp) = $Args[0]; shift(@Args);
2432         return($temp);
2433     } else {
2434         print STDERR "$Pgm: no argument following $option option\n";
2435         $Status++;
2436     }
2437 }
2438 \end{code}
2439
2440 \begin{code}
2441 sub isntAntiFlag {
2442     local($flag) = @_;
2443     local($f);
2444
2445 #Not in HsC_antiflag ## NO!: and not already in HsC_flags
2446
2447     foreach $f ( @HsC_antiflags ) {
2448         return(0) if $flag eq $f;
2449     }
2450 #    foreach $f ( @HsC_flags ) {
2451 #       return(0) if $flag eq $f;
2452 #    }
2453     return(1);
2454 }
2455
2456 sub squashHscFlag {  # pretty terrible
2457     local($flag) = @_;
2458     local($f);
2459
2460     foreach $f ( @HsC_flags ) {
2461         if ($flag eq $f) { $f = ''; }
2462     }
2463 }
2464
2465 sub add_Hsc_flags {
2466     local(@flags) = @_;
2467     local($f);
2468
2469     foreach $f ( @flags ) {
2470         push( @HsC_flags, $f ) if &isntAntiFlag($f);
2471     }
2472 }
2473 \end{code}
2474
2475 To add another system library, you'll need to augment the
2476 Supported_syslibs variable with name and info on your addition
2477 to the syslib family. The info bit consist of the following:
2478
2479    - interface file directory
2480        see the misc or posix entry for how to distinguish
2481        between using installed and build tree directories.
2482
2483    - directory location of archives
2484
2485    - location of (way-independent) C support libs.
2486        not all libraries need this - if you don't, just
2487        give the empty string.
2488    - list of syslibs you depend on.
2489
2490    - additional ghc command line flags that should be used.
2491    - additional C compiler command line flags that should be used.
2492    - link
2493
2494
2495 \begin{code}
2496
2497 # Hash to keep track of
2498 %Syslibs_added = ();
2499
2500 sub add_syslib {
2501     local($syslib) = @_;
2502
2503     # Lifting this out of this sub brings it out of scope - why??
2504     %Supported_syslibs =
2505      ( lang,
2506         [  # where to slurp interface files from
2507           ( $INSTALLING
2508                ? "$InstLibDirGhc/imports/lang"
2509                : "$TopPwd/hslibs/lang:$TopPwd/hslibs/lang/monads"
2510           )
2511         , # where to find the archive to use when linking
2512           ( $INSTALLING
2513                ? "$InstLibDirGhc"
2514                : "$TopPwd/hslibs/lang"
2515           )
2516         , # where to find the cbits archive to use when linking
2517           ( $INSTALLING
2518                ? "$InstLibDirGhc"
2519                : "$TopPwd/hslibs/lang/cbits"
2520           )
2521         , '' # Syslib dependencies
2522         , '' # extra ghc opts
2523         , '' # extra cc opts
2524         , '' # extra ld opts
2525         ],
2526
2527        concurrent,
2528         [  # where to slurp interface files from
2529           ( $INSTALLING
2530                ? "$InstLibDirGhc/imports/concurrent"
2531                : "$TopPwd/hslibs/concurrent"
2532           )
2533         , # where to find the archive to use when linking
2534           ( $INSTALLING
2535                ? "$InstLibDirGhc"
2536                : "$TopPwd/hslibs/concurrent"
2537           )
2538         , '' # where to find the cbits archive to use when linking
2539         , '' # Syslib dependencies
2540         , '' # extra ghc opts
2541         , '' # extra cc opts
2542         , '' # extra ld opts
2543         ],
2544
2545        data,
2546         [  # where to slurp interface files from
2547           ( $INSTALLING
2548                ? "$InstLibDirGhc/imports/data"
2549                : "$TopPwd/hslibs/data:$TopPwd/hslibs/data/edison:$TopPwd/hslibs/data/edison/Assoc:$TopPwd/hslibs/data/edison/Coll:$TopPwd/hslibs/data/edison/Seq"
2550           )
2551         , # where to find the archive to use when linking
2552           ( $INSTALLING
2553                ? "$InstLibDirGhc"
2554                : "$TopPwd/hslibs/data"
2555           )
2556         , '' # where to find the cbits archive to use when linking
2557         , 'lang' # Syslib dependencies
2558         , '' # extra ghc opts
2559         , '' # extra cc opts
2560         , '' # extra ld opts
2561         ],
2562
2563        net,
2564         [  # where to slurp interface files from
2565           ( $INSTALLING
2566                ? "$InstLibDirGhc/imports/net"
2567                : "$TopPwd/hslibs/net"
2568           )
2569         , # where to find the archive to use when linking
2570           ( $INSTALLING
2571                ? "$InstLibDirGhc"
2572                : "$TopPwd/hslibs/net"
2573           )
2574         , # where to find the cbits archive to use when linking
2575           ( $INSTALLING
2576                ? "$InstLibDirGhc"
2577                : "$TopPwd/hslibs/net/cbits"
2578           )
2579         , 'lang text' # Syslib dependencies
2580         , '' # extra ghc opts
2581         , '' # extra cc opts
2582         , ( $TargetPlatform =~ /-solaris2$/  ? '-lnsl -lsocket' : '')
2583         ],
2584
2585        posix,
2586         [  # where to slurp interface files from
2587           ( $INSTALLING
2588                ? "$InstLibDirGhc/imports/posix"
2589                : "$TopPwd/hslibs/posix"
2590           )
2591         , # where to find the archive to use when linking
2592           ( $INSTALLING
2593                ? "$InstLibDirGhc"
2594                : "$TopPwd/hslibs/posix"
2595           )
2596         , # where to find the cbits archive to use when linking
2597           ( $INSTALLING
2598                ? "$InstLibDirGhc"
2599                : "$TopPwd/hslibs/posix/cbits"
2600           )
2601         , 'lang' # Syslib dependencies
2602         , ''     # extra ghc opts
2603         , ''     # extra cc opts
2604         , ''     # extra ld opts
2605         ],
2606
2607        text,
2608         [  # where to slurp interface files from
2609           ( $INSTALLING
2610                ? "$InstLibDirGhc/imports/text"
2611                : "$TopPwd/hslibs/text:$TopPwd/hslibs/text/html:$TopPwd/hslibs/text/haxml/lib:$TopPwd/hslibs/text/parsec"
2612           )
2613         , # where to find the archive to use when linking
2614           ( $INSTALLING
2615                ? "$InstLibDirGhc"
2616                : "$TopPwd/hslibs/text"
2617           )
2618         , # where to find the cbits archive to use when linking
2619           ( $INSTALLING
2620                ? "$InstLibDirGhc"
2621                : "$TopPwd/hslibs/text/cbits"
2622           )
2623         , 'lang data' # Syslib dependencies
2624         , '' # extra ghc opts
2625         , '' # extra cc opts
2626         , '' # extra ld opts
2627         ],
2628
2629        util,
2630         [  # where to slurp interface files from
2631           ( $INSTALLING
2632                ? "$InstLibDirGhc/imports/util"
2633                : "$TopPwd/hslibs/util"
2634           )
2635         , # where to find the archive to use when linking
2636           ( $INSTALLING
2637                ? "$InstLibDirGhc"
2638                : "$TopPwd/hslibs/util"
2639           )
2640         , # where to find the cbits archive to use when linking
2641           ( $INSTALLING
2642                ? "$InstLibDirGhc"
2643                : "$TopPwd/hslibs/util/cbits"
2644           )
2645         , 'lang concurrent' # Syslib dependencies
2646         , ''     # extra ghc opts
2647         , ''     # extra cc opts
2648         , ''     # extra ld opts
2649         ],
2650
2651        win32,
2652         [  # where to slurp interface files from
2653           ( $INSTALLING
2654                ? "$InstLibDirGhc/imports/win32"
2655                : "$TopPwd/hslibs/win32/src"
2656           )
2657         , # where to find the archive to use when linking
2658           ( $INSTALLING
2659                ? "$InstLibDirGhc"
2660                : "$TopPwd/hslibs/win32/src"
2661           )
2662         , ''
2663         , 'lang' # Syslib dependencies
2664         , ''     # extra ghc opts
2665         , ''     # extra cc opts
2666         , '-luser32 -lgdi32'     # extra ld opts
2667         ],
2668
2669        com,
2670         [  # where to slurp interface files from
2671           ( $INSTALLING
2672                ? "$InstLibDirGhc/imports/com"
2673                : "$TopPwd/hdirect/lib"
2674           )
2675         , # where to find the archive to use when linking
2676           ( $INSTALLING
2677                ? "$InstLibDirGhc"
2678                : "$TopPwd/hdirect/lib"
2679           )
2680         , ''
2681         , 'lang' # Syslib dependencies
2682         , ''     # extra ghc opts
2683         , ''     # extra cc opts
2684         , '-luser32 -lole32 -loleaut32 -ladvapi32'
2685                  # extra ld opts
2686         ]
2687     );
2688
2689     # check if it's supported..
2690
2691     if ( !exists $Supported_syslibs{$syslib} ) {
2692        print STDERR "$Pgm: no such system library (-syslib): $syslib\n";
2693        $Status++;
2694        return;
2695     }
2696
2697     # This check is here to avoid syslib loops from
2698     # spoiling the party. A side-effect of it is that
2699     # it disallows multiple mentions of a syslib on a command-line,
2700     # explicit *and* implicit ones (i.e., "-syslib lang -syslib misc"
2701     # is not equal to "-syslib lang -syslib misc -syslib lang",
2702     # which it needs to be)
2703     #
2704     # Since our current collection of syslibs don't have any
2705     # loops, this test is disabled.
2706     #
2707     # ToDo: loop avoidance scheme when the need arises
2708     #
2709     #return if ( exists $Syslibs_added{$syslib} );
2710
2711     $Syslibs_added{$syslib} = 1;
2712
2713     local ($hi_dirs, $lib_dir, $lib_cbits_dir,
2714            $syslib_deps, $syslib_ghc_opts,
2715            $syslib_cc_opts, $syslib_ld_opts) = @{ $Supported_syslibs{$syslib} };
2716
2717     foreach(split(':',$hi_dirs)) {
2718         unshift(@SysImport_dir, $_);
2719     }
2720     push(@SysLibrary_dir, $lib_dir);
2721     push(@SysLibrary_dir, $lib_cbits_dir) if ( $lib_cbits_dir ne '');
2722
2723     push(@SysLibrary, "-lHS$syslib");
2724     push(@SysLibrary, "-lHS${syslib}_cbits") if ( $lib_cbits_dir ne '');
2725     push(@SysLibrary, $syslib_ld_opts) if ($syslib_ld_opts ne '');
2726
2727     # Add on any extra dependencies.
2728     foreach $lib (split(' ',$syslib_deps)) {
2729       &add_syslib($lib);
2730     }
2731 }
2732 \end{code}
2733
2734 Source files may have {-# OPTIONS ... #-} pragmas at the top, containing
2735 command line options we want to append to collection of commands specified
2736 directly. @check_for_source_options@ looks at the top of a de-lit'ified Haskell
2737 file for any such pragmas:
2738
2739 \begin{code}
2740 sub check_for_source_options {
2741     local($file,$ifile) = @_;
2742     local($comment_start,$comment_end);
2743
2744     if ($ifile =~ /\.hc$/ ||
2745         $ifile =~ /_hc$/  ||
2746         $ifile =~ /\.s$/  ||
2747         $ifile =~ /_s$/ ) {  # `Real' C intermediate
2748        $comment_start = "/\\*";
2749        $comment_end   = "\\*/";
2750     } else { # Assume it is a file containing Haskell source
2751        $comment_start = "{-#";
2752        $comment_end   = "#-}";
2753     }
2754
2755     open(FILE,$file) || return(1); # No big loss
2756
2757     while (<FILE>) {
2758         if ( /^${comment_start} OPTIONS (.*)${comment_end}/ ) {
2759            # add the options found at the back of the command line.
2760            local(@entries) = split(/\s+/,$1);
2761            print STDERR "Found OPTIONS " . join(' ',@entries) . " in $file\n" if $Verbose;
2762            push(@File_options, @entries);
2763         }
2764         elsif ( /^$/ ) { # ignore empty lines
2765            ;
2766         }
2767         elsif ( /^#line.+$/ ) { # ignore comment lines (unused..ToDo: rm )
2768            ;
2769         }
2770         elsif ( /^{-# LINE.+$/ ) { # ignore line pragmas
2771            ;
2772         }
2773         else { # stop looking, something non-empty / not
2774                # ${comment_start} OPTIONS .. ${comment_end} encountered.
2775             close(FILE);return(0);
2776         }
2777     }
2778     close(FILE);
2779     return(0);
2780 }
2781 \end{code}
2782
2783
2784 We split the initial argv up into three arrays:
2785
2786   - @Cmd_opts
2787   - @Link_file
2788   - @Input_file
2789
2790 the reason for doing so is to be able to deal
2791 with {-# OPTIONS #-} pragma in source files properly.
2792
2793 \begin{code}
2794 sub splitCmdLine {
2795     local(@args) = @_;
2796
2797 arg: while($_ = $args[0]) {
2798     shift(@args);
2799     # sigh, we have to deal with these -option arg specially here.
2800     /^-(tmpdir|odir|ohi|o|isuf|osuf|hisuf|odump|syslib)$/ &&
2801        do { push(@Cmd_opts, $_); push(@Cmd_opts,$args[0]); shift(@args); next arg; };
2802     /^--?./  && do { push(@Cmd_opts, $_); next arg; };
2803
2804     if (/\.([^_]+_)?[oa]$/) {
2805         push(@Link_file, $_);
2806     } else {
2807         push(@Input_file, $_);
2808     }
2809
2810     # input files must exist:
2811     if (! -f $_) {
2812         print STDERR "$Pgm: input file doesn't exist: $_\n";
2813         $Status++;
2814     }
2815   }
2816 }
2817
2818 \end{code}
2819
2820 When saving an intermediate file (.hc or .s) away, we
2821 have to prefix any OPTIONS found in the original source file.
2822
2823 \begin{code}
2824 sub saveIntermediate {
2825   local ($final,$suffix,$tmp)= @_ ;
2826   local ($to_do);
2827
2828   local ($new_suffix);
2829
2830   # $final  -- root of where to park ${final}.${suffix}
2831   # $tmp    -- temporary file where hsc put the intermediate file.
2832
2833   # HWL: use -odir for .hc and .s files, too
2834   if ( $Specific_output_dir ne '' ) {
2835     $final = "${Specific_output_dir}/${final}";
2836   }
2837   # HWL: use the same suffix as for $Osuffix in generating intermediate file,
2838   #      replacing o with hc or s, respectively.
2839   if ( $Osuffix ne '' ) {
2840     ($new_suffix = $Osuffix) =~ s/o$/hc/ if $suffix eq "hc";
2841     ($new_suffix = $Osuffix) =~ s/o$/s/ if $suffix eq "s";
2842     $suffix = $new_suffix;
2843     print stderr "HWL says: suffix for intermediate file is $suffix; ${final}.${suffix} overall\n" if $Verbose;
2844   }
2845
2846   # Delete the old file
2847   $to_do = "$Rm ${final}.${suffix}"; &run_something($to_do, "Removing old .${suffix} file");
2848
2849   if ( $#File_options >= 0 ) { # OPTIONS found in Haskell source unit
2850     # Add OPTION comment to the top of the generated .${suffix} file
2851     open(TEMP, "> ${final}.${suffix}") || &tidy_up_and_die(1,"Can't open ${final}.${suffix}\n");
2852     print TEMP "/* OPTIONS " . join(' ',@File_options) . " */\n";
2853     close(TEMP);
2854     print STDERR "Prepending OPTIONS: " . join(' ',@File_options) . " to ${final}.${suffix}\n" if $Verbose;
2855   }
2856   $to_do = "$Cat $tmp  >> ${final}.${suffix}";
2857   &run_something($to_do, "Saving copy of .${suffix} file");
2858
2859 }
2860
2861 \end{code}
2862
2863
2864 Command-line processor
2865
2866 \begin{code}
2867 sub processArgs {
2868     local(@Args) = @_;
2869
2870 # can't use getopt(s); what we want is too complicated
2871
2872 arg: while($_ = $Args[0]) {
2873     shift(@Args);
2874
2875     #---------- help -------------------------------------------------------
2876     if (/^-\?$/ || /^--?help$/) { print $LongUsage; exit $Status; }
2877
2878     #-----------version ----------------------------------------------------
2879     /^--version$/   && do { print STDERR "${ProjectName}, version ${ProjectVersion}\n"; exit $Status; };
2880
2881     #---------- verbosity and such -----------------------------------------
2882     /^-v$/          && do { $Verbose = '-v'; $Time = 'time'; next arg; };
2883
2884     #---------- what phases are to be run ----------------------------------
2885     /^-(no-)?recomp/        && do { $Do_recomp_chkr = ($1 eq '') ? 1 : 0; next arg; };
2886
2887     /^-cpp$/        && do { $Cpp_flag_set = 1; next arg; };
2888     # change the global default:
2889     # we won't run cat; we'll run the real thing
2890
2891     /^-C$/          && do { $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0; $HscOut = '-C=';
2892                             next arg; };
2893     # stop after generating C
2894
2895     /^-noC$/        && do { $HscOut = '-N='; $ProduceHi = '-nohifile=';
2896                             $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0;
2897                             next arg; };
2898     # leave out actual C generation (debugging) [also turns off interface gen]
2899
2900
2901     /^-hi$/              && do { $HiOnStdout = 1; $ProduceHi = '-hifile='; next arg; };
2902     # _do_ generate an interface; usually used as: -noC -hi
2903     /^-hi-with-(.*)$/    && do { $HiOnStdout = 1; $HiWith .= " $1" ; $ProduceHi = '-hifile='; next arg; };
2904     # limit ourselves to outputting a particular section.
2905
2906     /^-nohi$/       && do { $ProduceHi = '-nohifile='; next arg; };
2907     # don't generate an interface (even if generating C)
2908
2909     /^-hi-diffs$/             && do { $HiDiff_flag  = 'normal'; next arg; };
2910     /^-hi-diffs-with-usages$/ && do { $HiDiff_flag  = 'usages'; next arg; };
2911     /^-no-hi-diffs$/          && do { $HiDiff_flag  = '';       next arg; };
2912     /^-keep-hi-diffs$/        && do { $Keep_HiDiffs = 1; next arg; };
2913
2914     # show/disable diffs if the interface file changes
2915
2916     /^-E$/          && do { push(@CcBoth_flags, '-E');
2917                             $Only_preprocess_C = 1;
2918                             $Do_as = 0; $Do_lnkr = 0; next arg; };
2919     # stop after preprocessing C
2920     /^-M$/          && do { $Only_generate_deps = 1; $Do_as = 0; $Do_lnkr = 0; next arg; };
2921     # only generate dependency information.
2922     /^--mk-dll$/    && do { $Only_generate_dll  = 1; $Do_as = 0; $Do_lnkr = 0; next arg; };
2923     # Build a Win32 DLL (where supported).
2924     /^-S$/          && do { $Do_as = 0; $Do_lnkr = 0; next arg; };
2925     # stop after generating assembler
2926
2927     /^-c$/          && do { $Do_lnkr = 0; next arg; };
2928     # stop after generating .o files
2929
2930     /^-link-chk$/    && do { $LinkChk = 1; next arg; };
2931     # don't do consistency-checking after a link
2932     /^-no-link-chk$/ && do { $LinkChk = 0; next arg; };
2933
2934     /^-tmpdir$/ && do { $Tmp_prefix = &grab_arg_arg(*Args,'-tmpdir', '');
2935                         $Tmp_prefix = "$Tmp_prefix/ghc$$";
2936                         $ENV{'TMPDIR'} = $Tmp_prefix; # for those who use it...
2937                         next arg; };
2938     # use an alternate directory for temp files
2939
2940     #---------- redirect output --------------------------------------------
2941
2942     # -o <file>; applies to the last phase, whatever it is
2943     # "-o -" sends it to stdout
2944     # if <file> has a directory component, that dir must already exist
2945
2946     /^-odir$/       && do { $Specific_output_dir = &grab_arg_arg(*Args,'-odir', '');
2947                             #
2948                             # Hack, of the worst sort: don't do validation of
2949                             # odir argument if you're using -M (dependency generation).
2950                             #
2951                             if ( ! $Only_generate_deps && ! -d $Specific_output_dir) {
2952                                 print STDERR "$Pgm: -odir: no such directory: $Specific_output_dir\n";
2953                                 $Status++;
2954                             }
2955                             next arg; };
2956
2957     /^-o$/          && do { $Specific_output_file = &grab_arg_arg(*Args,'-o', '');
2958                             if ($Specific_output_file ne '-'
2959                              && $Specific_output_file =~ /(.*)\/[^\/]*$/) {
2960                                 local($dir_part) = $1;
2961                                 if (! -d $dir_part) {
2962                                     print STDERR "$Pgm: no such directory: $dir_part\n";
2963                                     $Status++;
2964                                 }
2965                             }
2966                             next arg; };
2967
2968     # NB: -isuf not documented yet (because it doesn't work yet)
2969     /^-isuf$/       && do { $Isuffix  = &grab_arg_arg(*Args,'-isuf', '');
2970                             if ($Isuffix =~ /\./ ) {
2971                                 print STDERR "$Pgm: -isuf suffix shouldn't contain a .\n";
2972                                 $Status++;
2973                             }
2974                             next arg; };
2975
2976     /^-osuf$/       && do { $Osuffix  = &grab_arg_arg(*Args,'-osuf', '');
2977                             if ($Osuffix =~ /\./ ) {
2978                                 print STDERR "$Pgm: -osuf suffix shouldn't contain a .\n";
2979                                 $Status++;
2980                             }
2981                             next arg; };
2982
2983     # -ohi <file>; send the interface to <file>; "-ohi -" to send to stdout
2984     /^-ohi$/        && do { $Specific_hi_file = &grab_arg_arg(*Args,'-ohi', '');
2985                             if ($Specific_hi_file ne '-'
2986                              && $Specific_hi_file =~ /(.*)\/[^\/]*$/) {
2987                                 local($dir_part) = $1;
2988                                 if (! -d $dir_part) {
2989                                     print STDERR "$Pgm: no such directory: $dir_part\n";
2990                                     $Status++;
2991                                 }
2992                             }
2993                             $ProduceHi='-hifile=';
2994                             next arg; };
2995
2996     # The suffix to use when looking for interface files
2997     /^-hisuf$/      && do { $HiSuffix = &grab_arg_arg(*Args,'-hisuf', '');
2998                             if ($HiSuffix =~ /\./ ) {
2999                                 print STDERR "$Pgm: -hisuf suffix shouldn't contain a .\n";
3000                                 $Status++;
3001                             }
3002                             next arg; };
3003     /^-odump$/      && do { $Specific_dump_file = &grab_arg_arg(*Args,'-odump', '');
3004                             if ($Specific_dump_file =~ /(.*)\/[^\/]*$/) {
3005                                 local($dir_part) = $1;
3006                                 if (! -d $dir_part) {
3007                                     print STDERR "$Pgm: no such directory: $dir_part\n";
3008                                     $Status++;
3009                                 }
3010                             }
3011                             next arg; };
3012
3013     #-------------- scc & Profiling Stuff ----------------------------------
3014
3015     /^-prof$/ && do { $PROFing = 'p'; next arg; }; # profiling -- details later!
3016
3017     /^-auto-dicts$/ && do {
3018                 $PROFdicts = '-fauto-sccs-on-dicts';
3019                 next arg; };
3020     /^-auto-all$/ && do {
3021                 $PROFauto = '-fauto-sccs-on-all-toplevs';
3022                 next arg; };
3023     /^-auto$/ && do {
3024                 $PROFauto = '-fauto-sccs-on-exported-toplevs';
3025                 next arg; };
3026
3027     /^-caf-all/ && do { # generate individual CAF SCC annotations
3028                 $PROFcaf = '-fauto-sccs-on-individual-cafs';
3029                 next arg; };
3030
3031     /^-ignore-scc$/ && do {
3032                 # forces ignore of scc annotations even if profiling
3033                 $PROFignore_scc = '-W';
3034                 next arg; };
3035
3036     /^-unprof-scc-auto/ && do {
3037                 # generate auto SCCs on top level bindings when not profiling.
3038                 # Used to measure optimisation effects of presence of sccs.
3039                 $UNPROFscc_auto = ( /-all/ )
3040                             ? '-fauto-sccs-on-all-toplevs'
3041                             : '-fauto-sccs-on-exported-toplevs';
3042                 next arg; };
3043
3044     #--------- ticky/parallel ----------------------------------------------
3045     # we sort out the details a bit later on
3046
3047     /^-gransim$/    && do { $GRANing   = 'g'; &add_syslib('concurrent'); next arg; }; # GranSim
3048     /^-ticky$/      && do { $TICKYing  = 't'; next arg; }; # ticky-ticky
3049     /^-parallel$/   && do { $PARing    = 'p'; &add_syslib('concurrent'); next arg; }; # parallel Haskell
3050     /^-smp$/        && do { $SMPing    = 's'; &add_syslib('concurrent'); next arg; }; # parallel Haskell
3051
3052     #-------------- "user ways" --------------------------------------------
3053
3054     (/^-user-setup-([a-oA-Z])$/ ) &&
3055            do {
3056                 /^-user-setup-([a-oA-Z])$/  && do { $BuildTag = "_$1"; };
3057
3058                 local($stuff) = $UserSetupOpts{$BuildTag};
3059                 local(@opts)  = split(/\s+/, $stuff);
3060
3061                 # feed relevant ops into the arg-processing loop (if any)
3062                 unshift(@Args, @opts) if $#opts >= 0;
3063
3064                 next arg; };
3065
3066     #---------- set search paths for libraries and things ------------------
3067
3068     # we do -i just like HBC (-i clears the list; -i<colon-separated-items>
3069     # prepends the items to the list); -I is for including C .h files.
3070
3071     /^-i$/          && do { @Import_dir = ();  # import path cleared!
3072                             @SysImport_dir = ();
3073                             print STDERR "WARNING: import paths cleared by `-i'\n";
3074                             next arg; };
3075
3076     /^-i(.*)/       && do { local(@new_items);
3077                             local($arg) = $1;
3078
3079                             #
3080                             if ( $arg =~ /;/ ) {
3081                                $SplitMarker=";";
3082                                @new_items = split( /;/, &grab_arg_arg(*Args,'-i', $arg));
3083                             } else {
3084                                @new_items = split( /:/, &grab_arg_arg(*Args,'-i', $arg));
3085                             }
3086                             unshift(@Import_dir, @new_items);
3087                             next arg; };
3088
3089     /^-I(.*)/       && do { push(@Include_dir,     &grab_arg_arg(*Args,'-I', $1)); next arg; };
3090     /^-L(.*)/       && do { push(@UserLibrary_dir, &grab_arg_arg(*Args,'-L', $1)); next arg; };
3091     /^-l(.*)/       && do { push(@UserLibrary,'-l'.&grab_arg_arg(*Args,'-l', $1)); next arg; };
3092
3093     /^-syslib(.*)/  && do { local($syslib) = &grab_arg_arg(*Args,'-syslib',$1);
3094                             &add_syslib($syslib);
3095                             next arg; };
3096
3097     #=======================================================================
3098     # various flags that we can harmlessly send to one program or another
3099     # (we will later "reclaim" some of the compiler ones now sent to gcc)
3100     #=======================================================================
3101
3102     #---------- this driver itself (ghc) -----------------------------------
3103     # these change what executable is run for each phase:
3104     /^-pgmL(.*)$/   && do { $Unlit      = $1; next arg; };
3105     /^-pgmP(.*)$/   && do { $HsCpp      = $1; next arg; };
3106     /^-pgmC(.*)$/   && do { $HsC        = $1; next arg; };
3107     /^-pgmcO?(.*)$/ && do { $CcRegd     = $1; next arg; }; # the O? for back compat
3108     /^-pgma(.*)$/   && do { $As         = $1; next arg; };
3109     /^-pgml(.*)$/   && do { $Lnkr       = $1; next arg; };
3110     /^-pgmdep(.*)$/ && do { $MkDependHS = $1; next arg; };
3111
3112     #---------- the get-anything-through opts (all pgms) -------------------
3113     # these allow arbitrary option-strings to go to any phase:
3114     /^-optL(.*)$/   && do { push(@Unlit_flags,      $1); next arg; };
3115     /^-optP(.*)$/   && do { push(@HsCpp_flags,      $1); next arg; };
3116     /^-optCrts(.*)$/&& do { push(@HsC_rts_flags,    $1); next arg; };
3117     /^-optC(.*)$/   && do { push(@HsC_flags,        $1); next arg; };
3118     /^-optcpp(.*)$/ && do { push(@Cpp_define,       $1); $Only_preprocess_hc = ($1 eq "-E"); next arg; };
3119     /^-optc(.*)$/   && do { push(@CcBoth_flags,     $1); next arg; };
3120     /^-opta(.*)$/   && do { push(@As_flags,         $1); next arg; };
3121     /^-optl(.*)$/   && do { push(@Ld_flags,         $1); next arg; };
3122     /^-optdll(.*)$/ && do { push(@Dll_flags,        $1); next arg; };
3123     /^-optdep(.*)$/ && do { push(@MkDependHS_flags, $1); next arg; };
3124
3125     #---------- Haskell C pre-processor (hscpp) ----------------------------
3126     /^-D(.*)/       && do { push(@HsCpp_flags, "'-D".&grab_arg_arg(*Args,'-D',$1)."'"); next arg; };
3127     /^-U(.*)/       && do { push(@HsCpp_flags, "'-U".&grab_arg_arg(*Args,'-U',$1)."'"); next arg; };
3128
3129     #---------- post-Haskell "assembler"------------------------------------
3130     /^-ddump-raw-asm$/            && do { $Dump_raw_asm        = 1; next arg; };
3131     /^-ddump-asm-splitting-info$/ && do { $Dump_asm_splitting_info = 1; next arg; };
3132
3133     #---------- Haskell compiler (hsc) -------------------------------------
3134
3135     /^-keep-hc-files?-too$/     && do { $Keep_hc_file_too = 1; next arg; };
3136     /^-keep-s-files?-too$/      && do { $Keep_s_file_too = 1;  next arg; };
3137
3138     /^-fignore-interface-pragmas$/ && do { push(@HsC_flags, $_); next arg; };
3139     /^-fignore-asserts$/           && do { push(@HsC_flags, $_); next arg; };
3140
3141     /^-fno-implicit-prelude$/      && do { $NoImplicitPrelude= 1; push(@HsC_flags, $_); next arg; };
3142
3143      #
3144      # have the compiler proper generate concurrent code,
3145      # really only used when you want to configure your own
3146      # special user compilation way.
3147      #
3148      # (ditto for -fgransim, fscc-profiling, -fparallel and -fticky-ticky)
3149      #
3150     /^-fscc-profiling$/   && do { push(@HsC_flags,$_); next arg; };
3151     /^-fticky-ticky$/     && do { push(@HsC_flags,$_); next arg; };
3152     /^-fgransim$/         && do { push(@HsC_flags,$_); next arg; };
3153     /^-fparallel$/        && do { push(@HsC_flags,$_); next arg; };
3154     /^-fsmp$/             && do { push(@HsC_flags,$_); next arg; };
3155
3156     /^-split-objs$/     && do {
3157                         if ( $TargetPlatform !~ /^(alpha|hppa1\.1|i386|m68k|mips|powerpc|rs6000|sparc)-/ ) {
3158                             $SplitObjFiles = 0;
3159                             print STDERR "WARNING: don't know how to split objects on this platform: $TargetPlatform\n`-split-objs' option ignored\n";
3160                         } else {
3161                             $SplitObjFiles = 1;
3162                             $HscOut = '-C=';
3163
3164                             push(@HsC_flags, "-fglobalise-toplev-names");
3165                             push(@CcBoth_flags, '-DUSE_SPLIT_MARKERS');
3166
3167                             require('ghc-split.prl')
3168                              || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-split.prl!\n");
3169                         }
3170                         next arg; };
3171
3172     /^-unreg$/              && do { $UNREGing = 'u'; next arg; };
3173     /^-funregisterised$/    && do { push(@HsC_flags, $_); next arg; };
3174     /^-fno-asm-mangling$/   && do { $DoAsmMangling = 0; next arg; };
3175
3176     /^-fallow-overlapping-instances$/ && do { push(@HsC_flags, $_); next arg; };
3177     /^-fallow-undecidable-instances$/ && do { push(@HsC_flags, $_); next arg; };
3178     /^-fhistory-size.*$/              && do { push(@HsC_flags, $_); next arg; };
3179     /^-fdicts-strict$/                && do { push(@HsC_flags, $_); next arg; };
3180     /^-fglasgow-exts$/
3181                 && do { push(@HsC_flags, $_);
3182
3183                         # -fglasgow-exts implies -syslib lang
3184                         &add_syslib('lang');
3185
3186                         next arg; };
3187
3188     /^-fspeciali[sz]e$/
3189                 && do { $Oopt_DoSpecialise = '-fspecialise'; next arg; };
3190     /^-fno-speciali[sz]e$/
3191                 && do { $Oopt_DoSpecialise = ''; next arg; };
3192
3193     /^-fusagesp$/
3194                 && do {  $Oopt_UsageSPInf = '-fusagesp';
3195                          push (@HsC_flags, '-fusagesp-on'); next arg; };
3196
3197     /^-fcompiling-prelude$/ && do { $CompilingPrelude=1; push(@HsC_flags, $_); next arg; };
3198
3199 # Now the foldr/build options, which are *on* by default (for -O).
3200
3201     /^-ffoldr-build$/
3202                     && do { $Oopt_FoldrBuild = 1;
3203                             #print "Yes F/B\n";
3204                             next arg; };
3205
3206     /^-fno-foldr-build$/
3207                     && do { $Oopt_FoldrBuild = 0;
3208                             next arg; };
3209
3210     # --------------- Renamer -------------
3211
3212
3213     /^-fno-prune-tydecls$/     && do { push(@HsC_flags, $_); next arg; };
3214     /^-fno-prune-instdecls$/     && do { push(@HsC_flags, $_); next arg; };
3215
3216     # ---------------
3217
3218     /^-fasm-(.*)$/  && do { $HscOut = '-S='; next arg; }; # force using nativeGen
3219     /^-fvia-[cC]$/          && do { $HscOut = '-C='; next arg; }; # force using C compiler
3220
3221     # ---------------
3222
3223     /^-funfolding-.*$/
3224                     && do { push(@HsC_flags, $_); next arg };
3225
3226     /^-fliberate-case-.*$/
3227                     && do { push(@HsC_flags, $_); next arg };
3228
3229     /^-funfold-casms-in-hi-file$/
3230                     && do { push(@HsC_flags, $_); next arg };
3231
3232     /^(-fmax-simplifier-iterations)(.*)$/
3233                     && do { $Oopt_MaxSimplifierIterations = $1 . &grab_arg_arg(*Args,$1, $2);
3234                             next arg; };
3235
3236     /^-fno-pedantic-bottoms$/
3237                     && do { $Oopt_PedanticBottoms = ''; next arg; };
3238
3239     /^-fno-pre-inlining$/
3240                     && do { push(@HsC_flags, $_); next arg };
3241
3242     /^-fno-let-from-(case|app|strict-let)$/ # experimental, really (WDP 95/10)
3243                     && do { push(@HsC_flags, $_); next arg; };
3244
3245     /^-funbox-strict-fields$/
3246                    && do { push(@HsC_flags, $_); next arg; };
3247
3248     # --------------- Warnings etc. ------
3249
3250     /^-fwarn-(.*)$/      && do { push(@HsC_flags, $_); next arg; };
3251
3252     /^-fno-(.*)$/   && do { push(@HsC_antiflags, "-f$1");
3253                             &squashHscFlag("-f$1");
3254                             next arg; };
3255
3256     /^-W$/          && do { push(@HsC_flags, @MinusWOpts); next arg; };
3257     /^-Wall$/       && do { push(@HsC_flags, @MinusWallOpts); next arg; };
3258     /^(-Wnot|w)$/   && do { foreach (@Hsc_flags) {
3259                                 /^-fwarn-(.*)$/ && do { $_=''; };
3260                             };
3261                             push(@HsC_antiflags, @StandardWarnings);
3262                             next arg; };
3263
3264     # --------------- fun stuff ----------------
3265
3266     /^-freport-compile$/ && do { push(@HsC_flags, $_); next arg; };
3267
3268     # --------------- platform specific flags (for gcc mostly) ----------------
3269
3270     /^-mlong-calls$/ && do { # for GCC for HP-PA boxes,
3271                              # for 2.6.x..?, does not apply for 2.7.2
3272                              # any longer.
3273                             unshift(@CcBoth_flags, ( $_ ));
3274                             next arg; };
3275
3276     /^-m(v8|sparclite|cypress|supersparc|cpu=(cypress|supersparc))$/
3277                      && do { # for GCC for SPARCs
3278                             unshift(@CcBoth_flags, ( $_ ));
3279                             next arg; };
3280
3281     /^-monly-([432])-regs/ && do { # for iX86 boxes only; no effect otherwise
3282                             $StolenX86Regs = $1;
3283                             next arg; };
3284
3285     #*************** ... and lots of debugging ones (form: -d* )
3286
3287     # -d(no-)core-lint is done this way so it is turn-off-able.
3288     /^-dcore-lint/       && do { $CoreLint = '-dcore-lint'; next arg; };
3289     /^-dno-core-lint/    && do { $CoreLint = '';            next arg; };
3290     # Ditto for USP lint
3291     /^-dusagesp-lint/    && do { $USPLint = '-dusagesp-lint'; next arg; };
3292     /^-dno-usagesp-lint/ && do { $USPLint = '';               next arg; };
3293     # Ditto for STG lint
3294     /^-dstg-lint/       && do { $StgLint = '-dstg-lint'; next arg; };
3295     /^-dno-stg-lint/    && do { $StgLint = '';           next arg; };
3296
3297     /^-d(dump|ppr)-/         && do { push(@HsC_flags, $_); next arg; };
3298     /^-dverbose-(simpl|stg)/ && do { push(@HsC_flags, $_); next arg; };
3299     /^-dshow-passes/         && do { push(@HsC_flags, $_); next arg; };
3300     /^-dshow-rn-stats/       && do { push(@HsC_flags, $_); next arg; };
3301     /^-dshow-rn-trace/       && do { push(@HsC_flags, $_); next arg; };
3302     /^-dsource-stats/        && do { push(@HsC_flags, $_); next arg; };
3303     /^-dsimplifier-stats/    && do { push(@HsC_flags, $_); next arg; };
3304     /^-dstg-stats/           && do { $Oopt_StgStats = $_; next arg; };
3305
3306     #*************** ... and now all these -R* ones for its runtime system...
3307
3308     /^-Rscale-sizes?(.*)/ && do {
3309         $Scale_sizes_by = &grab_arg_arg(*Args,'-Rscale-sizes', $1);
3310         next arg; };
3311
3312     /^(-H|-Rmax-heapsize)(.*)/ && do {
3313         local($heap_size) = &grab_arg_arg(*Args,$1, $2);
3314         if ($heap_size =~ /(\d+)[Kk]$/) {
3315             $heap_size = $1 * 1000;
3316         } elsif ($heap_size =~ /(\d+)[Mm]$/) {
3317             $heap_size = $1 * 1000 * 1000;
3318         } elsif ($heap_size =~ /(\d+)[Gg]$/) {
3319             $heap_size = $1 * 1000 * 1000 * 1000;
3320         }
3321         if ($heap_size <= 0) {
3322             print STDERR "$Pgm: resetting heap-size to zero!!! $heap_size\n";
3323             $Specific_heap_size = 0;
3324
3325         # if several heap sizes given, take the largest...
3326         } elsif ($heap_size >= $Specific_heap_size) {
3327             $Specific_heap_size = $heap_size;
3328         } else {
3329             print STDERR "$Pgm: ignoring heap-size-setting option ($_)...not the largest seen\n" if $Verbose;
3330         }
3331         next arg; };
3332
3333     /^(-K|Rmax-(stk|stack)size)(.*)/ && do {
3334         local($flag) = $1;
3335         local($stk_size) = &grab_arg_arg(*Args,'-Rmax-stksize', $3);
3336         if ($stk_size =~ /(\d+)[Kk]$/) {
3337             $stk_size = $1 * 1000;
3338         } elsif ($stk_size =~ /(\d+)[Mm]$/) {
3339             $stk_size = $1 * 1000 * 1000;
3340         } elsif ($stk_size =~ /(\d+)[Gg]$/) {
3341             $stk_size = $1 * 1000 * 1000 * 1000;
3342         }
3343         if ($stk_size <= 0) {
3344             print STDERR "$Pgm: resetting stack-size to zero!!! $stk_size\n";
3345             $Specific_stk_size = 0;
3346
3347         # if several stack sizes given, take the largest...
3348         } elsif ($stk_size >= $Specific_stk_size) {
3349             $Specific_stk_size = $stk_size;
3350         } else {
3351             print STDERR "$Pgm: ignoring stack-size-setting option ($flag $stk_size)...not the largest seen\n" if $Verbose;
3352         }
3353         next arg; };
3354
3355     /^-Rgc-stats$/ && do {  $CollectingGCstats++;
3356                             # the two RTSs do this diff ways; we will try to compensate
3357                             next arg; };
3358
3359     /^-Rghc-timing/ && do { $CollectGhcTimings = 1; next arg; };
3360
3361     #---------- C high-level assembler (gcc) -------------------------------
3362     /^-(Wall|ansi|pedantic)$/ && do { push(@CcBoth_flags, $_); next arg; };
3363
3364     # -dgcc-lint is a useful way of making GCC very fussy.
3365     # From alan@spri.levels.unisa.edu.au (Alan Modra).
3366     /^-dgcc-lint$/ && do { push(@CcBoth_flags, '-Wall -Wpointer-arith -Wbad-function-cast -Wcast-qual -Wstrict-prototypes -Wmissing-prototypes -Wmissing-declarations -Wnested-externs'); next arg; };
3367     # An alternate set, from mark@sgcs.com (Mark W. Snitily)
3368     # -Wall -Wstrict-prototypes -Wmissing-prototypes -Wcast-align -Wshadow
3369
3370     # inject "#include <wurble>" into the compiler's C output!
3371
3372     /^-#include(.*)/    && do {
3373         local($to_include) = &grab_arg_arg(*Args,'-#include', $1);
3374         push(@CcInjects, "#include $to_include\n");
3375         next arg; };
3376
3377     #---------- Linker (gcc, really) ---------------------------------------
3378
3379     /^-static$/         && do { $Static=1; push(@Ld_flags, $_); next arg; };
3380     /^-no-hs-main$/     && do { $NoHaskellMain=1; next arg;    };
3381
3382     #---------- mixed cc and linker magic ----------------------------------
3383     # this optimisation stuff is finally sorted out later on...
3384
3385     /^-O2-for-C$/ && do { $MinusO2ForC = 1; next arg; };
3386
3387     /^-O[1-2]?$/ && do {
3388                 local($opt_lev) = ( /^-O2$/ ) ? 2 : 1; # max 'em
3389                 $OptLevel = ( $opt_lev > $OptLevel ) ? $opt_lev : $OptLevel;
3390
3391                 $HscOut = '-C=' if $OptLevel == 2; # force use of C compiler
3392                 next arg; };
3393
3394     /^-Onot$/   && do { $OptLevel = 0; next arg; }; # # set it to <no opt>
3395
3396     /^-Ofile(.*)/ && do {
3397                 $OptLevel = 3;
3398                 local($ofile) = &grab_arg_arg(*Args,'-Ofile', $1);
3399                 @HsC_minusO3_flags = ();
3400
3401                 open(OFILE, "< $ofile") || die "Can't open $ofile!\n";
3402                 while (<OFILE>) {
3403                     chop;
3404                     s/\#.*//;       # death to comments
3405                     s/[ \t]+//g;    # death to whitespace
3406                     next if /^$/;   # ditto, blank lines
3407                     s/([()*{}])/\\$1/g;    # protect shell metacharacters
3408                     if ( /^C:(.*)/ ) {
3409                         push(@CcBoth_flags, $1);
3410                     } else {
3411                         push(@HsC_minusO3_flags, $_);
3412                     }
3413                 }
3414                 close(OFILE);
3415                 next arg; };
3416
3417     /^-debug$/  && do { # all this does is mark a .hc/.o as "debugging"
3418                         # in the consistency info
3419                         $DEBUGging = 'd';
3420                         next arg; };
3421
3422     #---------- linking .a file --------------------------------------------
3423
3424     /^-Main(.*)/ && do {
3425                 # specifies main or mainPrimIO to be linked
3426                 $Ld_main = $1;
3427                 next arg; };
3428
3429     #---------- catch unrecognized flags -----------------------------------
3430
3431     /^-./ && do {
3432         print STDERR "$Pgm: unrecognised option: $_\n";
3433         $Status++;
3434         next arg; };
3435
3436 }
3437
3438 } # end of processArgs
3439
3440 \end{code}