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}PrelException_BlockedOnDeadMVar_static_closure"
1107           ,'-u', "${uscore}__init_Prelude"
1108         ));
1109   if (!$NoHaskellMain) {
1110    unshift (@Ld_flags,'-u', "${uscore}PrelMain_mainIO_closure");
1111   }
1112   if ($TargetPlatform =~ /^powerpc-|^rs6000-/) {
1113     # sometimes we have lots of toc entries...
1114     #  unshift(@Ld_flags, ('-Xlinker -bbigtoc -Xlinker -bnoquiet'));
1115     unshift(@Ld_flags, ('-Xlinker -bbigtoc'));
1116   }
1117   if ($TargetPlatform =~ /^hppa/) {
1118     unshift(@Ld_flags, ('-Xlinker +vnocompatwarnings'));
1119   }
1120
1121 } # end of setupLinkOpts
1122
1123 \end{code}
1124
1125 %************************************************************************
1126 %*                                                                      *
1127 \subsection{Set up include paths and system-library enslurpment}
1128 %*                                                                      *
1129 %************************************************************************
1130
1131 Now that we know what garbage-collector, etc., are required, we can
1132 finalise our list of libraries to slurp through, and generally Get
1133 Ready for Business.
1134
1135 \begin{code}
1136 sub setupIncPaths {
1137   # default includes must be added AFTER option processing
1138   if ( ! $INSTALLING ) {
1139       push (@Include_dir, "$TopPwd/${CURRENT_DIR}/${GHC_INCLUDE_DIR}");
1140   } else {
1141       push (@Include_dir, "$InstLibDirGhc/includes");
1142       push (@Include_dir, "$InstLibDirGhc/includes");
1143   }
1144 } # end of setupIncPaths
1145 \end{code}
1146
1147 \begin{code}
1148 sub setupSyslibs {
1149   push(@SysLibrary, ( '-lHS', '-lHS_cbits' )); # basic I/O and prelude stuff
1150
1151   local($f);
1152   foreach $f (@SysLibrary) {
1153       next if $f =~ /_cbits/;
1154       $f .= $BuildTag if $f =~ /^-lHS/;
1155   }
1156
1157   # Push library HSrts, plus boring clib bit
1158   push(@SysLibrary, "-lHSrts${BuildTag}");
1159
1160   #
1161   # RTS compiled with cygwin32, uses the WinMM API
1162   # to implement the itimers, since cygwin.dll does not
1163   # support it. Only reqd. for `ways' that use itimers.
1164   #
1165   push(@SysLibrary, '-lwinmm')   if ($TargetPlatform =~ /-(mingw32|cygwin32)$/);
1166    # Note: currently only tested with mingw, may cause conflicts when linking
1167    #       with libcygwin.a
1168   push(@SysLibrary, '-lwsock32') if ($TargetPlatform =~ /-(mingw32|cygwin32)$/);
1169
1170   # Push the pvm libraries
1171   if ($BuildTag eq '_mp') {
1172       $pvmlib = "$ENV{'PVM_ROOT'}/lib/$ENV{'PVM_ARCH'}";
1173       push(@SysLibrary, "-L$pvmlib", '-lgpvm3', '-lpvm3');
1174       if ( $ENV{'PVM_ARCH'} eq 'SUNMP' ) {
1175           push(@SysLibrary, '-lthread', '-lsocket', '-lnsl');
1176       } elsif ( $ENV{'PVM_ARCH'} eq 'SUN4SOL2' ) {
1177           push(@SysLibrary, '-lsocket', '-lnsl');
1178       }
1179   }
1180
1181 # Push the GNU multi-precision arith lib; and the math library
1182
1183 # If this machine has GMP already installed, then we'll get the installed
1184 # lib here, because presumably the one in the tree won't have been built.
1185
1186 if ($LibGmp eq 'not-installed') {
1187   push(@SysLibrary, "-lgmp");
1188 } else {
1189   push(@SysLibrary, "-l$LibGmp");
1190 }
1191
1192 push(@SysLibrary, '-lm') if !( $TargetPlatform =~ /^.*(cygwin32|mingw32)$/ );
1193 \end{code}
1194
1195 %************************************************************************
1196 %*                                                                      *
1197 \subsection{Check that this system was built to do what we are asking}
1198 %*                                                                      *
1199 %************************************************************************
1200
1201 Before continuing we check that the appropriate build is available.
1202
1203 \begin{code}
1204 #die "$Pgm: no BuildAvail?? $BuildTag\n" if $BuildDescr{$BuildTag} eq '' ; # sanity
1205
1206 if ( $BuildDescr{$BuildTag} eq '' ) {
1207     print STDERR "$Pgm: a `", $BuildDescr{$BuildTag},
1208         "' \"build\" is not available with your GHC setup.\n";
1209     print STDERR "(It was not configured for it at your site.)\n";
1210     print STDERR $ShortUsage;
1211     exit 1;
1212 }
1213
1214 } # end of setupSyslibs
1215
1216 \end{code}
1217
1218 %************************************************************************
1219 %*                                                                      *
1220 \subsection{Final miscellaneous setup bits before we start going}
1221 %*                                                                      *
1222 %************************************************************************
1223
1224 Record largest specific heapsize, if any.
1225 \begin{code}
1226 sub setupHeapStackSize {
1227    $Specific_heap_size = $Specific_heap_size * $Scale_sizes_by;
1228    push(@HsC_rts_flags, '-H'.$Specific_heap_size);
1229    $Specific_stk_size = $Specific_stk_size * $Scale_sizes_by;
1230    push(@HsC_rts_flags, "-K$Specific_stk_size");
1231 }
1232 \end{code}
1233
1234 If no input or link files seen, then we let 'em feed in stdin; this is
1235 mainly for debugging.
1236
1237 \begin{code}
1238
1239 if ($#Input_file < 0 && $#Link_file < 0) {
1240     @Input_file = ( '-' );
1241
1242     open(INF, "> $Tmp_prefix.hs") || &tidy_up_and_die(1,"Can't open $Tmp_prefix.hs\n");
1243     print STDERR "Enter your Haskell program, end with ^D (on a line of its own):\n" if -t;
1244     while (<STDIN>) { print INF $_; }
1245     close(INF) || &tidy_up_and_die(1,"Failed writing to $Tmp_prefix.hs\n");
1246 }
1247
1248 \end{code}
1249
1250 Tell the world who we are, if they asked.
1251 \begin{code}
1252 print STDERR "${ProjectName}, version ${ProjectVersion}\n" if $Verbose;
1253 \end{code}
1254
1255 %************************************************************************
1256 %*                                                                      *
1257 \section[Driver-main-loop]{Main loop: Process input files, and link if required}
1258 %*                                                                      *
1259 %************************************************************************
1260
1261 Process the input files; don't continue with linking if there are
1262 problems (global variable @$Status@ non-zero).
1263 \begin{code}
1264 foreach $ifile (@Input_file) {
1265     &ProcessInputFile($ifile);
1266 }
1267
1268 # don't link if there were errors...
1269 if ( $Status > 0 ) {
1270     print STDERR $ShortUsage;
1271     &tidy_up();
1272     exit $Status;
1273 }
1274
1275 # Link if appropriate.
1276 &runLinker() if $Do_lnkr;
1277
1278 # that...  that's all, folks!
1279 &tidy_up();
1280 exit $Status; # will still be 0 if all went well
1281 \end{code}
1282
1283 %************************************************************************
1284 %*                                                                      *
1285 \section[Driver-do-one-file]{How to process a single input file}
1286 %*                                                                      *
1287 %************************************************************************
1288
1289 \begin{code}
1290 sub ProcessInputFile {
1291     local($ifile) = @_;   # input file name
1292     local($ifile_root);   # root of or basename of input file
1293     local($ofile_target); # ultimate output file we hope to produce
1294                           # from input file (need to know for recomp
1295                           # checking purposes)
1296     local($hifile_target);# ditto (but .hi file)
1297     local($ofile_c_stub_target);
1298     local($ofile_h_stub_target);
1299 \end{code}
1300
1301 Handle the weirdity of input from stdin.
1302 \begin{code}
1303     if ($ifile ne '-') {
1304         ($ifile_root  = $ifile) =~ s/\.[^\.\/]+$//;
1305         $ofile_target = # may be reset later...
1306                         ($Specific_output_file ne '' && ! $Do_lnkr)
1307                         ? $Specific_output_file
1308                         : &odir_ify($ifile_root, 'o');
1309         $hifile_target= ($Specific_hi_file ne '')
1310                         ? $Specific_hi_file
1311                         : "$ifile_root.$HiSuffix"; # ToDo: odirify?
1312                         # NB: may change if $ifile_root isn't module name (??)
1313         ($ofile_c_stub_target = $ifile) =~s/\.[^\.\/]+$/_stub.c/;
1314         ($ofile_h_stub_target = $ifile) =~s/\.[^\.\/]+$/_stub.h/;
1315     } else {
1316         $ifile = "$Tmp_prefix.hs"; # we know that's where we put the input
1317         $ifile_root   = '_stdin';
1318         $ofile_target = '_stdout'; # gratuitous?
1319         $hifile_target= '_stdout'; # ditto?
1320     }
1321 \end{code}
1322
1323 We need to decide what phases of the compilation system we will run
1324 over this file.  The defaults are the ones established when processing
1325 flags.  (That established what the last phase run for all files is.)
1326
1327 We do the pre-recompilation-checker phases here; the rest later.
1328 \begin{code}
1329 \end{code}
1330
1331 Look at the suffix and decide what initial phases of compilation may
1332 be dropped off for this file.  Also the rather boring business of
1333 which files are coming-in/going-out.
1334
1335 Again, we'll do the post-recompilation-checker parts of this later.
1336 \begin{code}
1337     local($do_lit2pgm)  = ($ifile =~ /\.lhs$/) ? 1 : 0;
1338     local($do_hscpp)    = 1; # but "hscpp" might really be "cat"
1339     local($do_hsc)      = 1;
1340
1341     # names of the files to stuff between phases
1342     # defaults are temporaries
1343     local($in_lit2pgm)    = $ifile;
1344     local($lit2pgm_hscpp) = "$Tmp_prefix.lpp";
1345     local($hscpp_hsc)     = "$Tmp_prefix.cpp";
1346     local($hsc_hi)        = "$Tmp_prefix.hi";
1347     local($cc_as_o)       = "${Tmp_prefix}_o.s"; # temporary for raw .s file if opt C
1348     local($cc_as)         = "$Tmp_prefix.s";     # mangled or hsc-produced .s code
1349     local($as_out)        = $ofile_target;
1350
1351     local($is_hc_file) = 1; #Is the C code .hc or .c? Assume .hc for now
1352
1353     # OK, let's strip off some literate junk..
1354     if ($do_lit2pgm) {
1355         &runLit2pgm($in_lit2pgm, $lit2pgm_hscpp)
1356     } else {
1357         $lit2pgm_hscpp = $ifile;
1358     }
1359
1360     #
1361     @File_options = ();
1362
1363     # Scan the top of the de-litted file for {-# OPTIONS #-} pragmas
1364     &check_for_source_options($lit2pgm_hscpp,$ifile);
1365
1366     # Options found in the source file take a back seat, i.e., we scan
1367     # them first. Only process the command line again if source file
1368     # contained anything of interest *or* there's more than one
1369     # input file (we have to reset the options).
1370     #
1371     if ( $#Input_file >= 0 || $#File_options >= 0) {
1372         #@File_options = (@File_options, @Cmd_opts);
1373
1374         # Now process the command line
1375         &initDriverGlobals();
1376         &processArgs((@File_options,@Cmd_opts));
1377         print STDERR "\nEffective command line: " .
1378                      join(' ',(@File_options,@Cmd_opts)) . "\n" if $Verbose;
1379     }
1380     #
1381     # Having got the effective command line scanned, set up
1382     # the various options in prep for some real work.
1383     #
1384     # check the sanity of the BuildTag we're about to use,
1385     # and if needs be, add some more flags and setup to
1386     # the different phases.
1387     #
1388     &setupBuildFlags();
1389     &setupOptimiseFlags();
1390     &setupMachOpts();
1391     &setupIncPaths();
1392     &setupWarningFlags();
1393     &setupHeapStackSize();
1394
1395     #
1396     # These two variables need to be set after the
1397     # command-line has been processed and the build options
1398     # have be seen set up. This is because command-line options
1399     # can control whether to compile vias C or not.
1400     #
1401     local($do_cc)       = ( $Do_cc != -1) # i.e., it was set explicitly
1402                           ? $Do_cc
1403                           : ( ($HscOut eq '-C=') ? 1 : 0 );
1404     local($do_as)       = $Do_as;
1405     local($hsc_out)        = ( $HscOut eq '-C=' ) ? "$Tmp_prefix.hc" : "$Tmp_prefix.s" ;
1406     local($hsc_out_c_stub) = ( $HscOut eq '-C=' ) ? "${Tmp_prefix}_stb.c" : "";
1407     local($hsc_out_h_stub) = ( $HscOut eq '-C=' ) ? "${Tmp_prefix}_stb.h" : "";
1408
1409     if ($Only_preprocess_hc) { # stop after having run $Cc -E
1410        $do_as=0;
1411     }
1412     if ($Only_preprocess_C)     { # stop after having run $hscpp
1413        $do_hsc=0; $do_cc = 0; $do_as=0;
1414     } elsif ($ifile =~ /.lhs$/ || $ifile =~ /.hs$/ ) {
1415        ;
1416     } elsif ($ifile =~ /\.hc$/ || $ifile =~ /_hc$/ ) { # || $ifile =~ /\.$Isuffix$/o) # ToDo: better
1417         $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
1418         $hsc_out = $ifile;
1419         $hsc_out_c_stub = '';
1420         $hsc_out_h_stub = '';
1421     } elsif ($ifile =~ /\.c$/) {
1422         $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
1423         $hsc_out = $ifile; $is_hc_file = 0;
1424         $hsc_out_c_stub = '';
1425         $hsc_out_h_stub = '';
1426     } elsif ($ifile =~ /\.[sS]$/) {
1427         $do_hscpp = 0; $do_hsc = 0; $do_cc = 0;
1428         $cc_as = $ifile;
1429     } else { # don't know what it is, but nothing to do herein...
1430         $do_hscpp = 0; $do_hsc = 0; $do_cc = 0; $do_as = 0;
1431     }
1432
1433     # hack to avoid running hscpp
1434     $HsCpp = $Cat if ! $Cpp_flag_set;
1435
1436     &runHscpp($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc) if $do_hscpp;
1437
1438 \end{code}
1439
1440 We now think about whether to run hsc/cc or not (when hsc produces .s
1441 stuff, it effectively takes the place of both phases).
1442 To get the output file name right: for each phase that we are {\em
1443 not} going to run, set its input (i.e., the output of its preceding
1444 phase) to @"$ifile_root.<suffix>"@.
1445
1446 \begin{code}
1447     local($going_interactive) = $HscOut eq '-N=' || $ifile_root eq '_stdin';
1448
1449     #
1450     # Warning issued if -keep-hc-file-too is used without
1451     # -fvia-C (or the equivalent)
1452     #
1453     if ( $HscOut ne '-C=' && $Keep_hc_file_too ) {
1454         print STDERR "$Pgm: warning: Native code generator to be used, -keep-hc-file-too will be ignored\n";
1455     }
1456
1457     if (! $do_cc && ! $do_as) { # stopping after hsc
1458         $hsc_out = ($Specific_output_file ne '')
1459                  ? $Specific_output_file
1460                  : &odir_ify($ifile_root, ($HscOut eq '-C=') ? 'hc' : 's');
1461
1462         $ofile_target = $hsc_out; # reset
1463     }
1464
1465     if (! $do_as) { # stopping after gcc (or hsc)
1466         $cc_as = ($Specific_output_file ne '')
1467                  ? $Specific_output_file
1468                  : &odir_ify($ifile_root, ( $Only_preprocess_hc ) ? 'i' : 's');
1469
1470         $ofile_target = $cc_as; # reset
1471     }
1472
1473 \end{code}
1474
1475
1476 Now the Haskell compiler, C compiler, and assembler
1477
1478 \begin{code}
1479    if ($do_hsc) {
1480         &runHscAndProcessInterfaces( $ifile, $hscpp_hsc, $ifile_root,
1481                                      $ofile_target, $hifile_target,
1482                                      $going_interactive);
1483     }
1484
1485     if (-f $hsc_out_h_stub) {
1486         &run_something("cp $hsc_out_h_stub $ofile_h_stub_target", 'Copy foreign export header file');
1487     }
1488
1489     if (-f $hsc_out_c_stub) {
1490         &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');
1491         local ($hsc_out_s_stub);
1492         local ($hsc_out_o_stub);
1493         ($ofile_s_stub_target = $ofile_c_stub_target) =~ s/\.(.*)$/\.s/;
1494         ($ofile_o_stub_target = $ofile_c_stub_target) =~ s/\.(.*)$//;
1495
1496         $ofile_o_stub_target = &osuf_ify($ofile_o_stub_target, "o");
1497         if ($do_cc) {
1498           &runGcc    (0, $ofile_c_stub_target, $ofile_s_stub_target);
1499           &runAs     ($ofile_o_stub_target, $ofile_s_stub_target);
1500         }
1501         #
1502         # Bring the C stub protos into scope when compiling the .hc file.
1503         #
1504         push (@CcInjects, "#include \"${hsc_out_h_stub}\"\n");
1505         # Hack - ensure that the stub .h file is included in the OPTIONS section
1506         #        if the .hc file is saved.
1507         push (@File_options, "-#include \"${ofile_h_stub_target}\"\n");
1508
1509     }
1510
1511     if ($do_cc) {
1512         &runGcc    ($is_hc_file, $hsc_out, $cc_as_o);
1513         &runMangler($is_hc_file, $cc_as_o, $cc_as, $ifile_root) if ! $Only_preprocess_hc;
1514     }
1515
1516     &split_asm_file($cc_as)  if $do_as && $SplitObjFiles;
1517
1518     # save a copy of the .s file..
1519     &saveIntermediate($ifile_root , "s" , $cc_as) if ($do_as && $Keep_s_file_too);
1520     &runAs($as_out, $ifile_root) if $do_as;
1521 \end{code}
1522
1523 Finally, decide what to queue up for linker input.
1524 \begin{code}
1525     # tentatively assume we will eventually produce linker input:
1526     push(@Link_file, &odir_ify($ifile_root, 'o'));
1527
1528 #ToDo:    local($or_isuf) = ($Isuffix eq '') ? '' : "|$Isuffix";
1529
1530     if ( $ifile !~ /\.(lhs|hs|hc|c|s|a|S)$/ && $ifile !~ /_hc$/ ) {
1531         # There's sometimes confusion regarding .hi files; users
1532         # supplying them on the command line.
1533         if ( $ifile =~ /\.hi$/ ) {
1534             print STDERR "$Pgm: warning: found `$ifile' on command line; interface files should not be supplied here - ignoring it.\n";
1535         } else {
1536            print STDERR "$Pgm: don't recognise suffix on `$ifile'; passing it through to linker\n";
1537         }
1538         # oops; we tentatively pushed the wrong thing; fix & do the right thing
1539         pop(@Link_file); push(@Link_file, $ifile);
1540     }
1541
1542
1543 } # end of ProcessInputFile
1544 \end{code}
1545
1546 %************************************************************************
1547 %*                                                                      *
1548 \section[Driver-run-phases]{Routines to run the various phases}
1549 %*                                                                      *
1550 %************************************************************************
1551
1552 \begin{code}
1553 sub runLit2pgm {
1554     local($in_lit2pgm, $lit2pgm_hscpp) = @_;
1555
1556     local($to_do) = "";
1557
1558     # Only add #line pragma if we're going to need it.
1559     $to_do  = "echo '#line 1 \"$in_lit2pgm\"' > $lit2pgm_hscpp && " if ($Cpp_flag_set);
1560     $to_do .= "$Unlit @Unlit_flags $in_lit2pgm -  >> $lit2pgm_hscpp";
1561
1562     push(@Files_to_tidy, $lit2pgm_hscpp );
1563
1564     &run_something($to_do, 'literate pre-processor');
1565 }
1566 \end{code}
1567
1568 \begin{code}
1569 sub runHscpp {
1570     local($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc) = @_;
1571
1572     local($to_do) = "";
1573
1574     # Strictly speaking, echoing of the following line pragma is only required
1575     # on non-delit'ed input, as we've already added it during de-lit. However,
1576     # hscpp will then add a {-# LINE 1 "$lit2pgm_hsc" -} to the top of the file,
1577     # which is not very informative (but harmless). Hence, we uniformly have
1578     # {-# LINE 1 "$in_lit2pgm" #-} as the first line to all cpp'ed hsc input.
1579     #
1580     $to_do = "echo '{-# LINE 1 \"$in_lit2pgm\" -}' > $hscpp_hsc && ";
1581
1582     if ($HsCpp eq $Cat) {
1583         $to_do .= "$HsCpp $lit2pgm_hscpp >> $hscpp_hsc";
1584         push(@Files_to_tidy, $hscpp_hsc );
1585         &run_something($to_do, 'Ineffective C pre-processor');
1586     } else {
1587         local($includes) = '-I' . join(' -I',@Include_dir);
1588         $to_do .= "$HsCpp $Verbose @HsCpp_flags @HsSourceCppOpts $includes $lit2pgm_hscpp >> $hscpp_hsc";
1589         push(@Files_to_tidy, $hscpp_hsc );
1590         &run_something($to_do, 'Haskellised C pre-processor');
1591     }
1592
1593     if ( $Only_preprocess_C ) {
1594         $to_do = "$Cat $hscpp_hsc";
1595         &run_something($to_do, '');
1596     }
1597
1598 }
1599 \end{code}
1600
1601
1602 \begin{code}
1603 sub runHscAndProcessInterfaces {
1604     local($ifile, $hscpp_hsc, $ifile_root,
1605           $ofile_target, $hifile_target,
1606           $going_interactive) = @_;
1607
1608         # $ifile                is the original input file
1609         # $hscpp_hsc            post-unlit, post-cpp, etc., input file
1610         # $ifile_root           input filename minus suffix
1611         # $ofile_target         the output file that we ultimately hope to produce
1612         # $hifile_target        the .hi file ... (ditto)
1613
1614     local($source_unchanged) = 1;
1615
1616     # Check if the source file is up to date relative to the target; in
1617     # that case we say "source is unchanged" and let the compiler bail out
1618     # early if the import usage information allows it.
1619
1620     ($i_dev,$i_ino,$i_mode,$i_nlink,$i_uid,$i_gid,$i_rdev,$i_size,
1621      $i_atime,$i_mtime,$i_ctime,$i_blksize,$i_blocks) = stat($ifile);
1622
1623     # The informational messages below are now conditional on -v being set -- SOF
1624     if ( $ofile_target ne "_stdin.s" && ! -f $ofile_target ) {
1625         print STDERR "$Pgm:compile:Output file $ofile_target doesn't exist\n" if $Verbose;
1626         $source_unchanged = 0;
1627     }
1628
1629     ($o_dev,$o_ino,$o_mode,$o_nlink,$o_uid,$o_gid,$o_rdev,$o_size,
1630      $o_atime,$o_mtime,$o_ctime,$o_blksize,$o_blocks) = stat(_); # stat info from -f test
1631
1632     if ( $hifile_target ne "_stdout" && ! -f $hifile_target ) {
1633         print STDERR "$Pgm:compile:Interface file $hifile_target doesn't exist\n" if $Verbose;
1634         $source_unchanged = 0;
1635     }
1636
1637     ($hi_dev,$hi_ino,$hi_mode,$hi_nlink,$hi_uid,$hi_gid,$hi_rdev,$hi_size,
1638      $hi_atime,$hi_mtime,$hi_ctime,$hi_blksize,$hi_blocks) = stat(_); # stat info from -f test
1639
1640     if ( $ofile_target ne "_stdin.s" && $i_mtime > $o_mtime) {
1641         print STDERR "$Pgm:recompile:Input file $ifile newer than $ofile_target\n" if $Verbose;
1642         $source_unchanged = 0;
1643     }
1644
1645     # Tell the compiler which version we're using
1646     push(@HsC_flags, "-fhi-version=${ProjectVersionInt}");
1647
1648     # So if source_unchanged is still "1", we pass on the good news to the compiler
1649     # The -recomp flag can disable this, forcing recompilation
1650     if ($Do_recomp_chkr && $source_unchanged) {
1651         push(@HsC_flags, '-fsource-unchanged');
1652     }
1653
1654     # Indicate whether we're static or not.
1655     # This will only ever
1656     push(@HsC_flags, '-static') if $Static;
1657
1658     # Run the compiler
1659
1660     &runHsc($ifile_root, $hsc_out, $hsc_hi, $hsc_out_c_stub, $hsc_out_h_stub, $going_interactive);
1661
1662    # See if it bailed out early, saying nothing needed doing.
1663    # We work this out by seeing if it created an output .hi file
1664
1665     if ( ! -f $hsc_hi && $ProduceHi !~ /-nohifile=/ ) {
1666         # Doesn't exist, so we bailed out early.
1667         # Tell the C compiler and assembler not to run
1668         $do_cc = 0; $do_as = 0;
1669
1670         # Update dependency info, touch both object file and
1671         # interface file, so that the following invariant is
1672         # maintained:
1673         #
1674         #   a dependent module's interface file should after recompilation
1675         #   checking be newer than the interface files of its imports.
1676         #
1677         # That is, if module A's interface file changes, then module B
1678         # (which import from A) needs to be checked.
1679         # If A's change does not affect B, which causes the compiler to bail
1680         # out early, we still need to touch the interface file of B. The reason
1681         # for this is that B may export A's interface.
1682         #
1683         &run_something("touch $ofile_target",
1684                        "Touch $ofile_target,  to propagate dependencies") if $HscOut ne '-N=';
1685         &run_something("touch $hifile_target",
1686                        "Touch $hifile_target,  to propagate dependencies") if $ProduceHi =~ /-nohifile=/ ;
1687
1688     } else {
1689
1690      # Didn't bail out early (new .hi file) so we thunder on
1691
1692         # If non-interactive, heave in the consistency info at the end
1693         # NB: pretty hackish (depends on how $output is set)
1694         if ( ! $going_interactive ) {
1695             if ( $HscOut eq '-C=' ) {
1696             $to_do = "echo 'static char ghc_hsc_ID[] = \"\@(#)hsc $ifile\t$HsC_major_version.$HsC_minor_version,$HsC_consist_options\";' >> $hsc_out";
1697
1698             } elsif ( $HscOut eq '-S=' ) {
1699                 local($consist) = "hsc.$ifile.$HsC_major_version.$HsC_minor_version.$HsC_consist_options";
1700                 $consist =~ s/,/./g;
1701                 $consist =~ s/\//./g;
1702                 $consist =~ s/-/_/g;
1703                 $consist =~ s/[^A-Za-z0-9_.]/ZZ/g; # ToDo: properly?
1704                 $to_do = "echo '\n\t.text\n$consist:' >> $hsc_out";
1705             }
1706             &run_something($to_do, 'Pin on Haskell consistency info');
1707         }
1708
1709
1710         # Interface-handling is important enough to live off by itself
1711         if ( $ProduceHi !~ /-nohifile=/ ) { # If we've produced one, process it.
1712            require('ghc-iface.prl') || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-iface.prl!\n");
1713            &postprocessHiFile($hsc_hi, $hifile_target, $going_interactive);
1714         }
1715         # if we're going to split up object files,
1716         # we inject split markers into the .hc file now
1717         if ( $HscOut eq '-C=' && $SplitObjFiles ) {
1718             &inject_split_markers ( $hsc_out );
1719         }
1720
1721         # save a copy of the .hc file, even if we are carrying on...
1722         if ($HscOut eq '-C=' && $do_cc && $Keep_hc_file_too) {
1723             &saveIntermediate($ifile_root , "hc" , $hsc_out);
1724         }
1725
1726     }
1727 }
1728 \end{code}
1729
1730
1731 \begin{code}
1732 sub runHsc {
1733     local($ifile_root, $hsc_out, $hsc_hi, $hsc_out_c_stub, $hsc_out_h_stub, $going_interactive) = @_;
1734
1735     &makeHiMap() unless $HiMapDone;
1736     push(@HsC_flags, "\"-himap=$HiIncludeString\"");
1737     push(@HsC_flags, "\"-himap-sep=${SplitMarker}\"");
1738
1739     # here, we may produce .hc/.s and/or .hi files
1740     local($output) = '';
1741     #@Files_to_tidy = ();
1742
1743     if ( $going_interactive ) {
1744         # don't need .hi unless we're going to show it on stdout:
1745         $ProduceHi = '-nohifile=' if ! ($HiOnStdout || $Specific_hi_file ne '' );
1746         $do_cc = 0; $do_as = 0; $Do_lnkr = 0; # and we won't go any further...
1747     }
1748
1749     # set up for producing output/.hi; note that flag twiddling
1750     # may mean that nothing will actually be produced:
1751     $output = "$ProduceHi$hsc_hi $HscOut$hsc_out -F=$hsc_out_c_stub -FH=$hsc_out_h_stub";
1752     push(@Files_to_tidy, $hsc_hi, $hsc_out, $hsc_out_c_stub, $hsc_out_h_stub );
1753
1754     # if we're compiling foo.hs, we want the GC stats to end up in foo.stat
1755     if ( $CollectingGCstats ) {
1756         push(@HsC_rts_flags, "-S$ifile_root.stat");
1757         push(@Files_to_tidy, "$ifile_root.stat");
1758     }
1759
1760     if ( $CollectGhcTimings ) { # assume $RTS_style eq 'ghc'
1761         # emit nofibbish time/bytes-alloc stats to stderr;
1762         # see later .stat file post-processing
1763         print STDERR "warning: both -Rgc-stats and -Rghc-timing used, -Rghc-timing wins." if $CollectingGCstats;
1764         push(@HsC_rts_flags, "-S$Tmp_prefix.stat");
1765         push(@Files_to_tidy, "$Tmp_prefix.stat");
1766     }
1767
1768     local($dump) = '';
1769     if ($Specific_dump_file ne '') {
1770         $dump = "2>> $Specific_dump_file";
1771         $Using_dump_file = 1;
1772     }
1773
1774     local($to_do);
1775     # Win32 only: If the command processor used by system()
1776     # exec()s the application as an ordinary Win32 executable,
1777     # we're in trouble here, since the command line is likely
1778     # to be > 255 chars long. To work around this situation,
1779     # $HsC also understands `at-files',  i.e., `@file' on the
1780     # command line will cause $HsC to add the contents of `file'
1781     # to the command line.
1782     #
1783     #  [ Note: support for `at-files' is not compiled in by default ]
1784     $cmd_line_opts_via_at_file=0;
1785     if ($cmd_line_opts_via_at_file) {
1786
1787       local($to_do_opts) = "$Tmp_prefix.opts";
1788       open(OPTS, "> $Tmp_prefix.opts") || &tidy_up_and_die(1,"Can't open $Tmp_prefix.opts\n");
1789       print OPTS "$dump @HsC_flags $CoreLint $USPLint $StgLint $Verbose";
1790       close(OPTS);
1791       $to_do = "$HsC $hscpp_hsc \@$Tmp_prefix.opts $output +RTS @HsC_rts_flags";
1792
1793     } else {
1794
1795     $to_do = "$HsC $hscpp_hsc $dump @HsC_flags $CoreLint $USPLint $StgLint $Verbose $output +RTS @HsC_rts_flags";
1796     }
1797     &run_something($to_do, 'Haskell compiler');
1798
1799     # finish business w/ nofibbish time/bytes-alloc stats
1800     &process_ghc_timings() if $CollectGhcTimings;
1801 }
1802 \end{code}
1803
1804 Use \tr{@Import_dir} and \tr{@SysImport_dir} to make a tmp file
1805 of (module-name, pathname) pairs, one per line, separated by a space.
1806 \begin{code}
1807 $HiMapDone = 0;
1808 $HiIncludeString = ();          # dir1:dir2:dir3, to pass to GHC
1809
1810 sub makeHiMap {
1811
1812     # collect in %HiMap; write later; also used elsewhere in driver
1813
1814     local($mod, $path, $d, $e);
1815
1816     # reset the global variables:
1817     $HiMapDone = 0;
1818     $HiIncludeString = ();              # dir1:dir2:dir3, to pass to GHC
1819
1820     foreach $d ( @Import_dir ) {
1821         if ($HiIncludeString) {
1822            $HiIncludeString = "$HiIncludeString${SplitMarker}${d}%.${HiSuffix}";
1823         } else {
1824            $HiIncludeString = "$d%.${HiSuffix}";
1825         }
1826
1827     }
1828
1829     foreach $d ( @SysImport_dir ) {
1830         if ($HiIncludeString) {
1831             $HiIncludeString = "$HiIncludeString${SplitMarker}${d}%.${HiSuffix_prelude}";
1832         } else {
1833             $HiIncludeString = "${d}%.${HiSuffix_prelude}";
1834         }
1835     }
1836
1837     $HiMapDone = 1;
1838 }
1839
1840 \end{code}
1841
1842 Invoke the 'linker' - either the standard linker or the one used to build
1843 a (Win32) DLL.
1844
1845 \begin{code}
1846 sub runLinker
1847 {
1848     local($libdirs) = '';
1849
1850     # append last minute flags linker and consistency flags
1851     &setupBuildFlags();
1852     &setupSyslibs();
1853     &setupLinkOpts();
1854
1855     # glue them together:
1856     push(@UserLibrary_dir, @SysLibrary_dir);
1857
1858     $libdirs = '-L' . join(' -L',@UserLibrary_dir) if $#UserLibrary_dir >= 0;
1859
1860     # for a linker, use an explicitly given one, or the going C compiler ...
1861     local($lnkr) = ( $Lnkr ) ? $Lnkr : $CcRegd;
1862
1863     if ( ($Specific_output_file eq '') &&
1864          ( ($TargetPlatform eq 'i386-unknown-cygwin32') ||
1865            ($TargetPlatform eq 'i386-unknown-mingw32')) ) {
1866          $Specific_output_file = 'main.exe';
1867          print STDERR "Output file not specified, defaulting to \"main.exe\"\n";
1868     }
1869
1870     local($output) = ($Specific_output_file ne '') ? "-o $Specific_output_file" : '';
1871     @Files_to_tidy = ($Specific_output_file ne '') ? $Specific_output_file : 'a.out';
1872
1873     &prepareWin32DllLink(1);
1874
1875     local($to_do) = "$lnkr $Verbose @Ld_flags $output @Link_file $libdirs @UserLibrary @SysLibrary";
1876     &run_something($to_do, 'Linker');
1877
1878     # finally, check the consistency info in the binary
1879     local($executable) = $Files_to_tidy[0];
1880     @Files_to_tidy = (); # reset; we don't want to nuke it if it's inconsistent
1881
1882     if ( $LinkChk ) {
1883         # dynamically load consistency-chking code; then do it.
1884         require('ghc-consist.prl')
1885             || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-consist.prl!\n");
1886
1887         &chk_consistency_info ( $executable );
1888     }
1889
1890     # if PVM parallel stuff, we do truly weird things.
1891     # Essentially: (1) move the executable over to where PVM expects
1892     # to find it.  (2) create a script in place of the executable
1893     # which will cause the program to be run, via SysMan.
1894     if ( $PARing eq 'p' ) {
1895         local($pvm_executable) = $executable;
1896         local($pvm_executable_base);
1897
1898         if ( $pvm_executable !~ /^\// ) { # a relative path name: make absolute
1899             local($pwd) = `pwd`;
1900             chop($pwd);
1901             $pwd =~ s/^\/tmp_mnt//;
1902             $pvm_executable = "$pwd/$pvm_executable";
1903         }
1904
1905         $pvm_executable =~ s|/|=|g; # make /s into =s
1906         $pvm_executable_base = $pvm_executable;
1907
1908         $pvm_executable = $ENV{'PVM_ROOT'} . '/bin/' . $ENV{'PVM_ARCH'}
1909                         . "/$pvm_executable";
1910
1911         &run_something("$Rm -f $pvm_executable; $Cp -p $executable $pvm_executable && $Rm -f $executable", 'Moving binary to PVM land');
1912
1913         # OK, now create the magic script for "$executable"
1914         open(EXEC, "> $executable") || &tidy_up_and_die(1,"$Pgm: couldn't open $executable to write!\n");
1915         print EXEC <<EOSCRIPT1;
1916 eval 'exec perl -S \$0 \${1+"\$@"}'
1917   if \$running_under_some_shell;
1918 # =!=!=!=!=!=!=!=!=!=!=!
1919 # This script is automatically generated: DO NOT EDIT!!!
1920 # Generated by Glasgow Haskell, version ${ProjectVersion}
1921 # ngoqvam choHbogh vaj' vIHoHnISbej !!!!
1922 #
1923 \$pvm_executable      = '$pvm_executable';
1924 \$pvm_executable_base = '$pvm_executable_base';
1925 \$SysMan = '$SysMan';
1926 EOSCRIPT1
1927
1928         print EXEC <<\EOSCRIPT2;
1929 # first, some magical shortcuts to run "commands" on the binary
1930 # (which is hidden)
1931 if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {
1932     local($cmd) = $1;
1933     system("$cmd $pvm_executable");
1934     exit(0); # all done
1935 }
1936
1937 # OK, really run it; process the args first
1938 $ENV{'PE'} = $pvm_executable_base;
1939 $debug = '';
1940 $nprocessors = 2; # the default
1941 @nonPVM_args = ();
1942 $in_RTS_args = 0;
1943
1944 # ToDo: handle --RTS
1945 args: while ($a = shift(@ARGV)) {
1946     if ( $a eq '+RTS' ) {
1947         $in_RTS_args = 1;
1948     } elsif ( $a eq '-RTS' ) {
1949         $in_RTS_args = 0;
1950     }
1951     if ( $a eq '-d' && $in_RTS_args ) {
1952         $debug = '-';
1953     } elsif ( $a =~ /^-qN(\d+)/ && $in_RTS_args ) {
1954         $nprocessors = $1;
1955     } elsif ( $a =~ /^-qp(\d+)/ && $in_RTS_args ) {
1956         $nprocessors = $1;
1957     } else {
1958         push(@nonPVM_args, $a);
1959     }
1960 }
1961
1962 local($return_val) = 0;
1963 system("$SysMan $debug $pvm_executable $nprocessors @nonPVM_args");
1964 $return_val = $?;
1965 system("mv $ENV{'HOME'}/$pvm_executable_base.???.gr .") if -f "$ENV{'HOME'}/$pvm_executable_base.001.gr";
1966 exit($return_val);
1967 EOSCRIPT2
1968         close(EXEC) || die "Failed closing $executable\n";
1969         chmod 0755, $executable;
1970     }
1971 }
1972
1973 sub createWin32DLL
1974 {
1975     local ($libdirs);
1976
1977     # append last minute flags linker and consistency flags
1978     &setupBuildFlags();
1979     &setupSyslibs();
1980     &setupLinkOpts();
1981
1982     # glue them together:
1983     push(@UserLibrary_dir, @SysLibrary_dir);
1984
1985     $libdirs = '-L' . join(' -L',@UserLibrary_dir) if $#UserLibrary_dir >= 0;
1986
1987     &prepareWin32DllLink(0);
1988
1989     local ($bld_dll) = "dllwrap";
1990
1991     local ($output) = ($Specific_output_file ne '') ? "$Specific_output_file" : 'HSdll.dll';
1992     local ($output_dir);
1993     local ($output_file);
1994     local ($output_lib, $output_def);
1995
1996     ($output_dir = $output) =~ s|(.*/)[^/]+$|$1|;
1997     $output_dir = "" if ($output_dir eq $output);
1998     ($output_file = $output) =~ s|.*/([^/]+)$|$1|;
1999
2000     ($output_lib = $output_file) =~ s|(.+)\.[^\.]*$|${output_dir}lib$1_imp.a|;
2001     ($output_def = $output_file) =~ s|(.+)\.[^\.]*$|${output_dir}$1.def|;
2002
2003     push (@Dll_flags, "-mno-cygwin --target=i386-mingw32") if ($TargetPlatform =~ /^.*mingw32$/);
2004     push (@Dll_flags, "--output-lib $output_lib");
2005     # If the "--def " option hasn't been supplied, assume everything
2006     # is going to be exported via the DLL.."
2007     if (!grep(/--def/, @Dll_flags)) {
2008       push (@Dll_flags, "--export-all --output-def $output_def");
2009     }
2010
2011     local($to_do) = "$bld_dll @Dll_flags -o $output @Link_file $libdirs @UserLibrary @SysLibrary";
2012     # Make sure the user sees this piece of magic.
2013     print STDERR "$to_do\n" if (!$Verbose);
2014     &run_something($to_do, 'DLL creator');
2015 }
2016
2017 sub prepareWin32DllLink
2018 {
2019     local($linking_main) = @_;
2020
2021     #
2022     # Win32 DLLs - link with import libraries, not the real archives.
2023     #
2024     if ( $TargetPlatform =~ /-mingw32$/ ) {
2025        if (!$Static) {
2026          #
2027          # If the libraries have the form libHSfoo.a, we
2028          # transform that into libHSfoo_imp.a - the import
2029          # library of the DLL.
2030          #
2031          foreach $a ( @SysLibrary ) {
2032            $a = "${a}_imp" if ($a =~ /^-lHS/);
2033          }
2034          foreach $a ( @UserLibrary ) {
2035            $a = "${a}_imp" if ($a =~ /^-lHS/);
2036          }
2037          push(@Link_file, ( $INSTALLING ) ? "$InstLibDirGhc/Main.dll_o"
2038                                           : "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR/Main.dll_o") if $linking_main;
2039          push(@Link_file, ( $INSTALLING ) ? "$InstLibDirGhc/PrelMain.dll_o"
2040                                           : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/std/PrelMain.dll_o") if $linking_main;
2041        }
2042        push(@Ld_flags,  "-mno-cygwin");
2043     }
2044 }
2045 \end{code}
2046
2047
2048 %************************************************************************
2049 %*                                                                      *
2050 \section[Driver-misc-utils]{Miscellaneous utilities}
2051 %*                                                                      *
2052 %************************************************************************
2053
2054 %************************************************************************
2055 %*                                                                      *
2056 \subsection[Driver-odir-ify]{@odir_ify@: Mangle filename if \tr{-odir} set}
2057 %*                                                                      *
2058 %************************************************************************
2059
2060 \begin{code}
2061 sub osuf_ify {
2062     local($ofile,$def_suffix) = @_;
2063
2064     return(($Osuffix eq '') ? "$ofile.$def_suffix" : "$ofile.$Osuffix" );
2065 }
2066
2067 sub odir_ify {
2068     local($orig_file, $def_suffix) = @_;
2069     if ($Specific_output_dir eq '') {   # do nothing
2070         &osuf_ify($orig_file, $def_suffix);
2071     } else {
2072         local ($orig_file_only);
2073         ($orig_file_only = $orig_file) =~ s|.*/||;
2074         &osuf_ify("$Specific_output_dir/$orig_file_only",$def_suffix);
2075     }
2076 }
2077 \end{code}
2078
2079 \begin{code}
2080 sub runGcc {
2081     local($is_hc_file, $hsc_out, $cc_as_o) = @_;
2082
2083     local($includes) = '-I' . join(' -I', @Include_dir);
2084     local($cc);
2085     local($s_output);
2086     local($c_flags) = "@CcBoth_flags";
2087     local($ddebug_flag) = ( $DEBUGging ) ? '-DDEBUG' : '';
2088
2089     $c_flags .= " -mno-cygwin" if ( $TargetPlatform =~ /-mingw32$/ );
2090
2091     # "input" files to use that are not in some weird directory;
2092     # to help C compilers grok .hc files [ToDo: de-hackify]
2093     local($cc_help)   = "ghc$$.c";
2094     local($cc_help_s) = "ghc$$.s";
2095
2096     $cc       = $CcRegd;
2097     $s_output = (($is_hc_file && $DoAsmMangling) || $TargetPlatform =~ /^(powerpc|rs6000|hppa)/) ? $cc_as_o : $cc_as;
2098     $c_flags .= " @CcRegd_flags";
2099     $c_flags .= ($is_hc_file) ? " @CcRegd_flags_hc"  : " @CcRegd_flags_c";
2100
2101     # C compiler won't like the .hc extension.  So we create
2102     # a tmp .c file which #include's the needful.
2103     open(TMP, "> $cc_help") || &tidy_up_and_die(1,"$Pgm: failed to open `$cc_help' (to write)\n");
2104     if ( $is_hc_file ) {
2105         print TMP <<EOINCL;
2106 #include "Stg.h"
2107 EOINCL
2108         # user may have asked for #includes to be injected...
2109         print TMP @CcInjects if $#CcInjects >= 0;
2110     } else {
2111         # Straight .c files may want to know that they're being used
2112         # with a particular version of GHC, so we define __GLASGOW_HASKELL__ for their benefit.
2113         print TMP "#define __GLASGOW_HASKELL__ ${ProjectVersionInt}\n";
2114     }
2115     # heave in the consistency info
2116     print TMP "static char ghc_cc_ID[] = \"\@(#)cc $ifile\t$Cc_major_version.$Cc_minor_version,$Cc_consist_options\";\n";
2117
2118     print TMP "#include \"$hsc_out\"\n";
2119     close(TMP) || &tidy_up_and_die(1,"Failed writing to $cc_help\n");
2120
2121     # Don't redirect stderr into intermediate file if slamming output onto stdout (e.g., with -E)
2122     local($fuse_stderr) = "2>&1" if ! $Only_preprocess_hc;
2123     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 )";
2124
2125     if ( $Only_preprocess_hc ) { # HACK ALERT!
2126         $to_do =~ s/ -S\b//g;
2127     }
2128     push(@Files_to_tidy, $cc_help, $cc_help_s, $s_output );
2129     $PostprocessCcOutput = 1 if ! $Only_preprocess_hc;  # hack, dear hack...
2130     &run_something($to_do, 'C compiler');
2131     $PostprocessCcOutput = 0;
2132     if ( $Only_preprocess_hc ) {
2133        system("$Cat $Tmp_prefix.ccout");
2134     }
2135     unlink($cc_help, $cc_help_s);
2136 }
2137 \end{code}
2138
2139 \begin{code}
2140 sub runMangler {
2141     local($is_hc_file, $cc_as_o, $cc_as, $ifile_root) = @_;
2142
2143     print STDERR `cat $cc_as_o` if $Dump_raw_asm; # to stderr, before mangling
2144
2145     if ($is_hc_file && $DoAsmMangling) {
2146         # dynamically load assembler-fiddling code, which we are about to use:
2147         require('ghc-asm.prl')
2148              || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm.prl!\n");
2149         # post-process the assembler [.hc files only]
2150         &mangle_asm($cc_as_o, $cc_as);
2151
2152     } elsif ($TargetPlatform =~ /^hppa/) {
2153         # minor mangling of non-threaded files for hp-pa only
2154         require('ghc-asm.prl')
2155         || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-hppa.prl!\n");
2156         &mini_mangle_asm_hppa($cc_as_o, $cc_as);
2157
2158     } elsif ($TargetPlatform =~ /^powerpc|^rs6000/) {
2159         # minor mangling of non-threaded files for powerpcs and rs6000s
2160         require('ghc-asm.prl')
2161         || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-powerpc.prl!\n");
2162         &mini_mangle_asm_powerpc($cc_as_o, $cc_as);
2163     }
2164
2165     # save a copy of the .s file, even if we are carrying on...
2166     #if ($do_as && $Keep_s_file_too) {
2167     #    &saveIntermediate($ifile_root , "s" , $cc_as);
2168     #}
2169 }
2170 \end{code}
2171
2172 \begin{code}
2173 sub runAs {
2174     local($as_out, $ifile_root) = @_;
2175
2176     local($asmblr) = ( $As ) ? $As : $CcRegd;
2177
2178     # need to add the -I flags in case the file is going through cpp (.S files)
2179     local($includes) = '-I' . join(' -I', @Include_dir);
2180
2181    if ( ! $SplitObjFiles || $ifile_root =~ /_stub\.s$/ ) {
2182         local($to_do)  = "$asmblr -o $as_out -c @As_flags $includes $cc_as";
2183         push(@Files_to_tidy, $as_out );
2184         &run_something($to_do, 'Unix assembler');
2185
2186     } else { # more complicated split-ification...
2187
2188         # must assemble files $Tmp_prefix__[1 .. $NoOfSplitFiles].s
2189
2190         # If -odir is used, great, just pin it in front of the
2191         # generated split file names. If it hasn't been set, we
2192         # snatch it from the ifile_root.
2193         #
2194         #
2195
2196         if ( $Specific_output_dir eq '' ) {
2197             $Specific_output_dir = ${ifile_root};
2198         }
2199
2200         for ($f = 1; $f <= $NoOfSplitFiles; $f++ ) {
2201             local($split_out) = &odir_ify("${ifile_root}__${f}",'o');
2202             local($to_do) = "$asmblr -o $split_out -c @As_flags ${Tmp_prefix}__${f}.s";
2203             push(@Files_to_tidy, $split_out );
2204
2205             &run_something($to_do, 'Unix assembler');
2206         }
2207     }
2208 }
2209 \end{code}
2210
2211 %************************************************************************
2212 %*                                                                      *
2213 \subsection[Driver-run-something]{@run_something@: Run a phase}
2214 %*                                                                      *
2215 %************************************************************************
2216
2217 \begin{code}
2218 sub run_something {
2219     local($str_to_do, $tidy_name) = @_;
2220
2221     print STDERR "\n$tidy_name:\n\t" if $Verbose;
2222     print STDERR "$str_to_do\n" if $Verbose;
2223
2224     if ($Using_dump_file) {
2225         open(DUMP, ">> $Specific_dump_file")
2226             || &tidy_up_and_die(1,"$Pgm: failed to open `$Specific_dump_file'\n");
2227         print DUMP "\nCompilation Dump for: $str_to_do\n\n";
2228         close(DUMP)
2229             || &tidy_up_and_die(1,"$Pgm: failed closing `$Specific_dump_file'\n");
2230     }
2231
2232     local($return_val) = 0;
2233
2234     if ( length($str_to_do) > 4000) {
2235       # 4000 - on the random side, just like the *real* ARG_MAX
2236       # for some shells.
2237
2238       # With some shells, command lines of this length may
2239       # very well cause trouble. To safeguard against this, we squirrel the
2240       # command into a file and exec that.
2241       local ($sh) = $ENV{'REAL_SHELL'};
2242       print STDERR "Backup plan A: saving cmd line in ${Tmp_prefix}.sh and executing that with $sh\n" if $Verbose;
2243       open (TEMP, "> ${Tmp_prefix}.sh") ||
2244                 &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.sh'\n");
2245       print TEMP "$Time $str_to_do\n";
2246       close (TEMP) ||
2247                 &tidy_up_and_die(1,"$Pgm: failed closing `$Tmp_prefix.sh'\n");
2248       system("$sh $Tmp_prefix.sh");
2249       $return_val = $?;
2250
2251       unlink "${Tmp_prefix}.sh";
2252     } else {
2253       system("$Time $str_to_do");
2254       $return_val = $?;
2255     }
2256
2257     if ( $PostprocessCcOutput ) { # hack, continued
2258         open(CCOUT, "< $Tmp_prefix.ccout")
2259             || &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.ccout'\n");
2260         while ( <CCOUT> ) {
2261             next if /call-clobbered/;
2262             next if /control reaches end/;
2263             next if /from .*Stg\.h:/;
2264             next if /from ghc\d+.c:\d+:/;
2265             next if /: At top level:$/;
2266             next if /: In function \`.*\':$/;
2267             next if /\`ghc_cc_ID\' defined but not used/;
2268             print STDERR $_;
2269         }
2270         close(CCOUT) || &tidy_up_and_die(1,"$Pgm: failed closing `$Tmp_prefix.ccout'\n");
2271     }
2272
2273     local($signal_num)  = $? & 127;
2274     local($dumped_core) = $? & 128;
2275
2276     if ($signal_num != 0) {
2277         print STDERR "$tidy_name received signal $signal_num";
2278         if ($dumped_core != 0) {
2279                 print STDERR " (core dumped)";
2280         }
2281         print STDERR "\n";
2282     }
2283
2284     if ($return_val != 0) {
2285         if ($Using_dump_file) {
2286             print STDERR "Compilation Errors dumped in $Specific_dump_file\n";
2287         }
2288         &tidy_up_and_die($return_val, '');
2289     }
2290
2291     $Using_dump_file = 0;
2292 }
2293 \end{code}
2294
2295 %************************************************************************
2296 %*                                                                      *
2297 \subsection[Driver-ghc-timing]{Emit nofibbish GHC timings}
2298 %*                                                                      *
2299 %************************************************************************
2300
2301 NB: nearly the same as in @runstdtest@ script.
2302
2303 \begin{code}
2304 sub process_ghc_timings {
2305     local($StatsFile) = "$Tmp_prefix.stat";
2306     local($SysSpecificTiming) = 'ghc';
2307
2308     open(STATS, $StatsFile) || die "Failed when opening $StatsFile\n";
2309     local($max_live)    = 0;
2310     local($tot_live)    = 0; # for calculating residency stuff
2311     local($tot_samples) = 0;
2312
2313     while (<STATS>) {
2314         if (! /Gen:\s+0/ && ! /Minor/ && /^\s*\d+\s+\d+\s+(\d+)\s+\d+\.\d+/ ) {
2315                 $max_live = $1 if $max_live < $1;
2316                 $tot_live += $1;
2317                 $tot_samples += 1;
2318         }
2319         $BytesAlloc = $1 if /^\s*([0-9,]+) bytes allocated in the heap/;
2320
2321         if ( /^\s*([0-9,]+) bytes maximum residency .* (\d+) sample/ ) {
2322             $MaxResidency = $1; $ResidencySamples = $2;
2323         }
2324
2325         $GCs = $1 if /^\s*([0-9,]+) (collections? in generation 0|garbage collections? performed)/;
2326
2327         if ( /^\s+([0-9]+)\s+Mb total memory/ ) {
2328             $TotMem = $1;
2329         }
2330
2331         # The presence of -? in the following pattern is only there to
2332         # accommodate 0.29 && <= 2.05 RTS'
2333         if ( /^\s*INIT\s+time\s*(\d+\.\d\d)s\s*\(\s*-?(\d+\.\d\d)s elapsed\)/ ) {
2334             $InitTime = $1; $InitElapsed = $2;
2335         } elsif ( /^\s*MUT\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2336             $MutTime = $1; $MutElapsed = $2;
2337         } elsif ( /^\s*GC\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2338             $GcTime = $1; $GcElapsed = $2;
2339         }
2340     }
2341     close(STATS) || die "Failed when closing $StatsFile\n";
2342     if ( $tot_samples > 0 ) {
2343         $ResidencySamples = $tot_samples;
2344         $MaxResidency = $max_live;
2345         $AvgResidency = int ($tot_live / $tot_samples) ;
2346     }
2347
2348     # warn about what we didn't find
2349     print STDERR "Warning: BytesAlloc not found in stats file\n" unless defined($BytesAlloc);
2350     print STDERR "Warning: GCs not found in stats file\n" unless defined($GCs);
2351     print STDERR "Warning: InitTime not found in stats file\n" unless defined($InitTime);
2352     print STDERR "Warning: InitElapsed not found in stats file\n" unless defined($InitElapsed);
2353     print STDERR "Warning: MutTime not found in stats file\n" unless defined($MutTime);
2354     print STDERR "Warning: MutElapsed not found in stats file\n" unless defined($MutElapsed);
2355     print STDERR "Warning: GcTime inot found in stats file\n" unless defined($GcTime);
2356     print STDERR "Warning: GcElapsed not found in stats file\n" unless defined($GcElapsed);
2357
2358     # things we didn't necessarily expect to find
2359     $MaxResidency     = 0 unless defined($MaxResidency);
2360     $AvgResidency     = 0 unless defined($AvgResidency);
2361     $ResidencySamples = 0 unless defined($ResidencySamples);
2362
2363     # a bit of tidying
2364     $BytesAlloc =~ s/,//g;
2365     $MaxResidency =~ s/,//g;
2366     $GCs =~ s/,//g;
2367     $InitTime =~ s/,//g;
2368     $InitElapsed =~ s/,//g;
2369     $MutTime =~ s/,//g;
2370     $MutElapsed =~ s/,//g;
2371     $GcTime =~ s/,//g;
2372     $GcElapsed =~ s/,//g;
2373
2374     # print out what we found
2375     print STDERR "<<$SysSpecificTiming: ",
2376         "$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)",
2377         " :$SysSpecificTiming>>\n";
2378
2379     # OK, party over
2380     unlink $StatsFile;
2381 }
2382 \end{code}
2383
2384 %************************************************************************
2385 %*                                                                      *
2386 \subsection[Driver-dying]{@tidy_up@ and @tidy_up_and_die@: Dying gracefully}
2387 %*                                                                      *
2388 %************************************************************************
2389
2390 \begin{code}
2391 sub tidy_up {
2392     local($to_do) = "\n$Rm $Tmp_prefix*";
2393     if ( $Tmp_prefix !~ /^\s*$/ ) {
2394         print STDERR "$to_do\n" if $Verbose;
2395         system($to_do);
2396     }
2397 }
2398
2399 sub tidy_up_and_die {
2400     local($return_val, $msg) = @_;
2401
2402     # delete any files to tidy
2403     print STDERR "deleting... @Files_to_tidy\n" if $Verbose && $#Files_to_tidy >= 0;
2404     unlink @Files_to_tidy if $#Files_to_tidy >= 0;
2405
2406     &tidy_up();
2407     print STDERR $msg;
2408     exit (($return_val == 0) ? 0 : 1);
2409 }
2410 \end{code}
2411
2412 %************************************************************************
2413 %*                                                                      *
2414 \subsection[Driver-arg-with-arg]{@grab_arg_arg@: Do an argument with an argument}
2415 %*                                                                      *
2416 %************************************************************************
2417
2418 Some command-line arguments take an argument, e.g.,
2419 \tr{-Rmax-heapsize} expects a number to follow.  This can either be
2420 given a part of the same argument (\tr{-Rmax-heapsize8M}) or as the
2421 next argument (\tr{-Rmax-heapsize 8M}).  We allow both cases.
2422
2423 Note: no error-checking; \tr{-Rmax-heapsize -Rgc-stats} will silently
2424 gobble the second argument (and probably set the heapsize to something
2425 nonsensical).
2426 \begin{code}
2427 sub grab_arg_arg {
2428     local(*Args, $option, $rest_of_arg) = @_;
2429
2430     if ($rest_of_arg ne '') {
2431         return($rest_of_arg);
2432     } elsif ($#Args >= 0) {
2433         local($temp) = $Args[0]; shift(@Args);
2434         return($temp);
2435     } else {
2436         print STDERR "$Pgm: no argument following $option option\n";
2437         $Status++;
2438     }
2439 }
2440 \end{code}
2441
2442 \begin{code}
2443 sub isntAntiFlag {
2444     local($flag) = @_;
2445     local($f);
2446
2447 #Not in HsC_antiflag ## NO!: and not already in HsC_flags
2448
2449     foreach $f ( @HsC_antiflags ) {
2450         return(0) if $flag eq $f;
2451     }
2452 #    foreach $f ( @HsC_flags ) {
2453 #       return(0) if $flag eq $f;
2454 #    }
2455     return(1);
2456 }
2457
2458 sub squashHscFlag {  # pretty terrible
2459     local($flag) = @_;
2460     local($f);
2461
2462     foreach $f ( @HsC_flags ) {
2463         if ($flag eq $f) { $f = ''; }
2464     }
2465 }
2466
2467 sub add_Hsc_flags {
2468     local(@flags) = @_;
2469     local($f);
2470
2471     foreach $f ( @flags ) {
2472         push( @HsC_flags, $f ) if &isntAntiFlag($f);
2473     }
2474 }
2475 \end{code}
2476
2477 To add another system library, you'll need to augment the
2478 Supported_syslibs variable with name and info on your addition
2479 to the syslib family. The info bit consist of the following:
2480
2481    - interface file directory
2482        see the misc or posix entry for how to distinguish
2483        between using installed and build tree directories.
2484
2485    - directory location of archives
2486
2487    - location of (way-independent) C support libs.
2488        not all libraries need this - if you don't, just
2489        give the empty string.
2490    - list of syslibs you depend on.
2491
2492    - additional ghc command line flags that should be used.
2493    - additional C compiler command line flags that should be used.
2494    - link
2495
2496
2497 \begin{code}
2498
2499 # Hash to keep track of
2500 %Syslibs_added = ();
2501
2502 sub add_syslib {
2503     local($syslib) = @_;
2504
2505     # Lifting this out of this sub brings it out of scope - why??
2506     %Supported_syslibs =
2507      ( lang,
2508         [  # where to slurp interface files from
2509           ( $INSTALLING
2510                ? "$InstLibDirGhc/imports/lang"
2511                : "$TopPwd/hslibs/lang:$TopPwd/hslibs/lang/monads"
2512           )
2513         , # where to find the archive to use when linking
2514           ( $INSTALLING
2515                ? "$InstLibDirGhc"
2516                : "$TopPwd/hslibs/lang"
2517           )
2518         , # where to find the cbits archive to use when linking
2519           ( $INSTALLING
2520                ? "$InstLibDirGhc"
2521                : "$TopPwd/hslibs/lang/cbits"
2522           )
2523         , '' # Syslib dependencies
2524         , '' # extra ghc opts
2525         , '' # extra cc opts
2526         , '' # extra ld opts
2527         ],
2528
2529        concurrent,
2530         [  # where to slurp interface files from
2531           ( $INSTALLING
2532                ? "$InstLibDirGhc/imports/concurrent"
2533                : "$TopPwd/hslibs/concurrent"
2534           )
2535         , # where to find the archive to use when linking
2536           ( $INSTALLING
2537                ? "$InstLibDirGhc"
2538                : "$TopPwd/hslibs/concurrent"
2539           )
2540         , '' # where to find the cbits archive to use when linking
2541         , '' # Syslib dependencies
2542         , '' # extra ghc opts
2543         , '' # extra cc opts
2544         , '' # extra ld opts
2545         ],
2546
2547        data,
2548         [  # where to slurp interface files from
2549           ( $INSTALLING
2550                ? "$InstLibDirGhc/imports/data"
2551                : "$TopPwd/hslibs/data:$TopPwd/hslibs/data/edison:$TopPwd/hslibs/data/edison/Assoc:$TopPwd/hslibs/data/edison/Coll:$TopPwd/hslibs/data/edison/Seq"
2552           )
2553         , # where to find the archive to use when linking
2554           ( $INSTALLING
2555                ? "$InstLibDirGhc"
2556                : "$TopPwd/hslibs/data"
2557           )
2558         , '' # where to find the cbits archive to use when linking
2559         , 'lang' # Syslib dependencies
2560         , '' # extra ghc opts
2561         , '' # extra cc opts
2562         , '' # extra ld opts
2563         ],
2564
2565        net,
2566         [  # where to slurp interface files from
2567           ( $INSTALLING
2568                ? "$InstLibDirGhc/imports/net"
2569                : "$TopPwd/hslibs/net"
2570           )
2571         , # where to find the archive to use when linking
2572           ( $INSTALLING
2573                ? "$InstLibDirGhc"
2574                : "$TopPwd/hslibs/net"
2575           )
2576         , # where to find the cbits archive to use when linking
2577           ( $INSTALLING
2578                ? "$InstLibDirGhc"
2579                : "$TopPwd/hslibs/net/cbits"
2580           )
2581         , 'lang text' # Syslib dependencies
2582         , '' # extra ghc opts
2583         , '' # extra cc opts
2584         , ( $TargetPlatform =~ /-solaris2$/  ? '-lnsl -lsocket' : '')
2585         ],
2586
2587        posix,
2588         [  # where to slurp interface files from
2589           ( $INSTALLING
2590                ? "$InstLibDirGhc/imports/posix"
2591                : "$TopPwd/hslibs/posix"
2592           )
2593         , # where to find the archive to use when linking
2594           ( $INSTALLING
2595                ? "$InstLibDirGhc"
2596                : "$TopPwd/hslibs/posix"
2597           )
2598         , # where to find the cbits archive to use when linking
2599           ( $INSTALLING
2600                ? "$InstLibDirGhc"
2601                : "$TopPwd/hslibs/posix/cbits"
2602           )
2603         , 'lang' # Syslib dependencies
2604         , ''     # extra ghc opts
2605         , ''     # extra cc opts
2606         , ''     # extra ld opts
2607         ],
2608
2609        text,
2610         [  # where to slurp interface files from
2611           ( $INSTALLING
2612                ? "$InstLibDirGhc/imports/text"
2613                : "$TopPwd/hslibs/text:$TopPwd/hslibs/text/html:$TopPwd/hslibs/text/haxml/lib"
2614           )
2615         , # where to find the archive to use when linking
2616           ( $INSTALLING
2617                ? "$InstLibDirGhc"
2618                : "$TopPwd/hslibs/text"
2619           )
2620         , # where to find the cbits archive to use when linking
2621           ( $INSTALLING
2622                ? "$InstLibDirGhc"
2623                : "$TopPwd/hslibs/text/cbits"
2624           )
2625         , 'lang data' # Syslib dependencies
2626         , '' # extra ghc opts
2627         , '' # extra cc opts
2628         , '' # extra ld opts
2629         ],
2630
2631        util,
2632         [  # where to slurp interface files from
2633           ( $INSTALLING
2634                ? "$InstLibDirGhc/imports/util"
2635                : "$TopPwd/hslibs/util:$TopPwd/hslibs/util/check"
2636           )
2637         , # where to find the archive to use when linking
2638           ( $INSTALLING
2639                ? "$InstLibDirGhc"
2640                : "$TopPwd/hslibs/util"
2641           )
2642         , # where to find the cbits archive to use when linking
2643           ( $INSTALLING
2644                ? "$InstLibDirGhc"
2645                : "$TopPwd/hslibs/util/cbits"
2646           )
2647         , 'lang concurrent' # Syslib dependencies
2648         , ''     # extra ghc opts
2649         , ''     # extra cc opts
2650         , ''     # extra ld opts
2651         ],
2652
2653        win32,
2654         [  # where to slurp interface files from
2655           ( $INSTALLING
2656                ? "$InstLibDirGhc/imports/win32"
2657                : "$TopPwd/hslibs/win32/src"
2658           )
2659         , # where to find the archive to use when linking
2660           ( $INSTALLING
2661                ? "$InstLibDirGhc"
2662                : "$TopPwd/hslibs/win32/src"
2663           )
2664         , ''
2665         , 'lang' # Syslib dependencies
2666         , ''     # extra ghc opts
2667         , ''     # extra cc opts
2668         , '-luser32 -lgdi32'     # extra ld opts
2669         ],
2670
2671        com,
2672         [  # where to slurp interface files from
2673           ( $INSTALLING
2674                ? "$InstLibDirGhc/imports/com"
2675                : "$TopPwd/hdirect/lib"
2676           )
2677         , # where to find the archive to use when linking
2678           ( $INSTALLING
2679                ? "$InstLibDirGhc"
2680                : "$TopPwd/hdirect/lib"
2681           )
2682         , ''
2683         , 'lang' # Syslib dependencies
2684         , ''     # extra ghc opts
2685         , ''     # extra cc opts
2686         , '-luser32 -lole32 -loleaut32 -ladvapi32'
2687                  # extra ld opts
2688         ]
2689     );
2690
2691     # check if it's supported..
2692
2693     if ( !exists $Supported_syslibs{$syslib} ) {
2694        print STDERR "$Pgm: no such system library (-syslib): $syslib\n";
2695        $Status++;
2696        return;
2697     }
2698
2699     # This check is here to avoid syslib loops from
2700     # spoiling the party. A side-effect of it is that
2701     # it disallows multiple mentions of a syslib on a command-line,
2702     # explicit *and* implicit ones (i.e., "-syslib lang -syslib misc"
2703     # is not equal to "-syslib lang -syslib misc -syslib lang",
2704     # which it needs to be)
2705     #
2706     # Since our current collection of syslibs don't have any
2707     # loops, this test is disabled.
2708     #
2709     # ToDo: loop avoidance scheme when the need arises
2710     #
2711     #return if ( exists $Syslibs_added{$syslib} );
2712
2713     $Syslibs_added{$syslib} = 1;
2714
2715     local ($hi_dirs, $lib_dir, $lib_cbits_dir,
2716            $syslib_deps, $syslib_ghc_opts,
2717            $syslib_cc_opts, $syslib_ld_opts) = @{ $Supported_syslibs{$syslib} };
2718
2719     foreach(split(':',$hi_dirs)) {
2720         unshift(@SysImport_dir, $_);
2721     }
2722     push(@SysLibrary_dir, $lib_dir);
2723     push(@SysLibrary_dir, $lib_cbits_dir) if ( $lib_cbits_dir ne '');
2724
2725     push(@SysLibrary, "-lHS$syslib");
2726     push(@SysLibrary, "-lHS${syslib}_cbits") if ( $lib_cbits_dir ne '');
2727     push(@SysLibrary, $syslib_ld_opts) if ($syslib_ld_opts ne '');
2728
2729     # Add on any extra dependencies.
2730     foreach $lib (split(' ',$syslib_deps)) {
2731       &add_syslib($lib);
2732     }
2733 }
2734 \end{code}
2735
2736 Source files may have {-# OPTIONS ... #-} pragmas at the top, containing
2737 command line options we want to append to collection of commands specified
2738 directly. @check_for_source_options@ looks at the top of a de-lit'ified Haskell
2739 file for any such pragmas:
2740
2741 \begin{code}
2742 sub check_for_source_options {
2743     local($file,$ifile) = @_;
2744     local($comment_start,$comment_end);
2745
2746     if ($ifile =~ /\.hc$/ ||
2747         $ifile =~ /_hc$/  ||
2748         $ifile =~ /\.s$/  ||
2749         $ifile =~ /_s$/ ) {  # `Real' C intermediate
2750        $comment_start = "/\\*";
2751        $comment_end   = "\\*/";
2752     } else { # Assume it is a file containing Haskell source
2753        $comment_start = "{-#";
2754        $comment_end   = "#-}";
2755     }
2756
2757     open(FILE,$file) || return(1); # No big loss
2758
2759     while (<FILE>) {
2760         if ( /^${comment_start} OPTIONS (.*)${comment_end}/ ) {
2761            # add the options found at the back of the command line.
2762            local(@entries) = split(/\s+/,$1);
2763            print STDERR "Found OPTIONS " . join(' ',@entries) . " in $file\n" if $Verbose;
2764            push(@File_options, @entries);
2765         }
2766         elsif ( /^$/ ) { # ignore empty lines
2767            ;
2768         }
2769         elsif ( /^#line.+$/ ) { # ignore comment lines (unused..ToDo: rm )
2770            ;
2771         }
2772         elsif ( /^{-# LINE.+$/ ) { # ignore line pragmas
2773            ;
2774         }
2775         else { # stop looking, something non-empty / not
2776                # ${comment_start} OPTIONS .. ${comment_end} encountered.
2777             close(FILE);return(0);
2778         }
2779     }
2780     close(FILE);
2781     return(0);
2782 }
2783 \end{code}
2784
2785
2786 We split the initial argv up into three arrays:
2787
2788   - @Cmd_opts
2789   - @Link_file
2790   - @Input_file
2791
2792 the reason for doing so is to be able to deal
2793 with {-# OPTIONS #-} pragma in source files properly.
2794
2795 \begin{code}
2796 sub splitCmdLine {
2797     local(@args) = @_;
2798
2799 arg: while($_ = $args[0]) {
2800     shift(@args);
2801     # sigh, we have to deal with these -option arg specially here.
2802     /^-(tmpdir|odir|ohi|o|isuf|osuf|hisuf|odump|syslib)$/ &&
2803        do { push(@Cmd_opts, $_); push(@Cmd_opts,$args[0]); shift(@args); next arg; };
2804     /^--?./  && do { push(@Cmd_opts, $_); next arg; };
2805
2806     if (/\.([^_]+_)?[oa]$/) {
2807         push(@Link_file, $_);
2808     } else {
2809         push(@Input_file, $_);
2810     }
2811
2812     # input files must exist:
2813     if (! -f $_) {
2814         print STDERR "$Pgm: input file doesn't exist: $_\n";
2815         $Status++;
2816     }
2817   }
2818 }
2819
2820 \end{code}
2821
2822 When saving an intermediate file (.hc or .s) away, we
2823 have to prefix any OPTIONS found in the original source file.
2824
2825 \begin{code}
2826 sub saveIntermediate {
2827   local ($final,$suffix,$tmp)= @_ ;
2828   local ($to_do);
2829
2830   local ($new_suffix);
2831
2832   # $final  -- root of where to park ${final}.${suffix}
2833   # $tmp    -- temporary file where hsc put the intermediate file.
2834
2835   # HWL: use -odir for .hc and .s files, too
2836   if ( $Specific_output_dir ne '' ) {
2837     $final = "${Specific_output_dir}/${final}";
2838   }
2839   # HWL: use the same suffix as for $Osuffix in generating intermediate file,
2840   #      replacing o with hc or s, respectively.
2841   if ( $Osuffix ne '' ) {
2842     ($new_suffix = $Osuffix) =~ s/o$/hc/ if $suffix eq "hc";
2843     ($new_suffix = $Osuffix) =~ s/o$/s/ if $suffix eq "s";
2844     $suffix = $new_suffix;
2845     print stderr "HWL says: suffix for intermediate file is $suffix; ${final}.${suffix} overall\n" if $Verbose;
2846   }
2847
2848   # Delete the old file
2849   $to_do = "$Rm ${final}.${suffix}"; &run_something($to_do, "Removing old .${suffix} file");
2850
2851   if ( $#File_options >= 0 ) { # OPTIONS found in Haskell source unit
2852     # Add OPTION comment to the top of the generated .${suffix} file
2853     open(TEMP, "> ${final}.${suffix}") || &tidy_up_and_die(1,"Can't open ${final}.${suffix}\n");
2854     print TEMP "/* OPTIONS " . join(' ',@File_options) . " */\n";
2855     close(TEMP);
2856     print STDERR "Prepending OPTIONS: " . join(' ',@File_options) . " to ${final}.${suffix}\n" if $Verbose;
2857   }
2858   $to_do = "$Cat $tmp  >> ${final}.${suffix}";
2859   &run_something($to_do, "Saving copy of .${suffix} file");
2860
2861 }
2862
2863 \end{code}
2864
2865
2866 Command-line processor
2867
2868 \begin{code}
2869 sub processArgs {
2870     local(@Args) = @_;
2871
2872 # can't use getopt(s); what we want is too complicated
2873
2874 arg: while($_ = $Args[0]) {
2875     shift(@Args);
2876
2877     #---------- help -------------------------------------------------------
2878     if (/^-\?$/ || /^--?help$/) { print $LongUsage; exit $Status; }
2879
2880     #-----------version ----------------------------------------------------
2881     /^--version$/   && do { print STDERR "${ProjectName}, version ${ProjectVersion}\n"; exit $Status; };
2882
2883     #---------- verbosity and such -----------------------------------------
2884     /^-v$/          && do { $Verbose = '-v'; $Time = 'time'; next arg; };
2885
2886     #---------- what phases are to be run ----------------------------------
2887     /^-(no-)?recomp/        && do { $Do_recomp_chkr = ($1 eq '') ? 1 : 0; next arg; };
2888
2889     /^-cpp$/        && do { $Cpp_flag_set = 1; next arg; };
2890     # change the global default:
2891     # we won't run cat; we'll run the real thing
2892
2893     /^-C$/          && do { $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0; $HscOut = '-C=';
2894                             next arg; };
2895     # stop after generating C
2896
2897     /^-noC$/        && do { $HscOut = '-N='; $ProduceHi = '-nohifile=';
2898                             $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0;
2899                             next arg; };
2900     # leave out actual C generation (debugging) [also turns off interface gen]
2901
2902
2903     /^-hi$/              && do { $HiOnStdout = 1; $ProduceHi = '-hifile='; next arg; };
2904     # _do_ generate an interface; usually used as: -noC -hi
2905     /^-hi-with-(.*)$/    && do { $HiOnStdout = 1; $HiWith .= " $1" ; $ProduceHi = '-hifile='; next arg; };
2906     # limit ourselves to outputting a particular section.
2907
2908     /^-nohi$/       && do { $ProduceHi = '-nohifile='; next arg; };
2909     # don't generate an interface (even if generating C)
2910
2911     /^-hi-diffs$/             && do { $HiDiff_flag  = 'normal'; next arg; };
2912     /^-hi-diffs-with-usages$/ && do { $HiDiff_flag  = 'usages'; next arg; };
2913     /^-no-hi-diffs$/          && do { $HiDiff_flag  = '';       next arg; };
2914     /^-keep-hi-diffs$/        && do { $Keep_HiDiffs = 1; next arg; };
2915
2916     # show/disable diffs if the interface file changes
2917
2918     /^-E$/          && do { push(@CcBoth_flags, '-E');
2919                             $Only_preprocess_C = 1;
2920                             $Do_as = 0; $Do_lnkr = 0; next arg; };
2921     # stop after preprocessing C
2922     /^-M$/          && do { $Only_generate_deps = 1; $Do_as = 0; $Do_lnkr = 0; next arg; };
2923     # only generate dependency information.
2924     /^--mk-dll$/    && do { $Only_generate_dll  = 1; $Do_as = 0; $Do_lnkr = 0; next arg; };
2925     # Build a Win32 DLL (where supported).
2926     /^-S$/          && do { $Do_as = 0; $Do_lnkr = 0; next arg; };
2927     # stop after generating assembler
2928
2929     /^-c$/          && do { $Do_lnkr = 0; next arg; };
2930     # stop after generating .o files
2931
2932     /^-link-chk$/    && do { $LinkChk = 1; next arg; };
2933     # don't do consistency-checking after a link
2934     /^-no-link-chk$/ && do { $LinkChk = 0; next arg; };
2935
2936     /^-tmpdir$/ && do { $Tmp_prefix = &grab_arg_arg(*Args,'-tmpdir', '');
2937                         $Tmp_prefix = "$Tmp_prefix/ghc$$";
2938                         $ENV{'TMPDIR'} = $Tmp_prefix; # for those who use it...
2939                         next arg; };
2940     # use an alternate directory for temp files
2941
2942     #---------- redirect output --------------------------------------------
2943
2944     # -o <file>; applies to the last phase, whatever it is
2945     # "-o -" sends it to stdout
2946     # if <file> has a directory component, that dir must already exist
2947
2948     /^-odir$/       && do { $Specific_output_dir = &grab_arg_arg(*Args,'-odir', '');
2949                             #
2950                             # Hack, of the worst sort: don't do validation of
2951                             # odir argument if you're using -M (dependency generation).
2952                             #
2953                             if ( ! $Only_generate_deps && ! -d $Specific_output_dir) {
2954                                 print STDERR "$Pgm: -odir: no such directory: $Specific_output_dir\n";
2955                                 $Status++;
2956                             }
2957                             next arg; };
2958
2959     /^-o$/          && do { $Specific_output_file = &grab_arg_arg(*Args,'-o', '');
2960                             if ($Specific_output_file ne '-'
2961                              && $Specific_output_file =~ /(.*)\/[^\/]*$/) {
2962                                 local($dir_part) = $1;
2963                                 if (! -d $dir_part) {
2964                                     print STDERR "$Pgm: no such directory: $dir_part\n";
2965                                     $Status++;
2966                                 }
2967                             }
2968                             next arg; };
2969
2970     # NB: -isuf not documented yet (because it doesn't work yet)
2971     /^-isuf$/       && do { $Isuffix  = &grab_arg_arg(*Args,'-isuf', '');
2972                             if ($Isuffix =~ /\./ ) {
2973                                 print STDERR "$Pgm: -isuf suffix shouldn't contain a .\n";
2974                                 $Status++;
2975                             }
2976                             next arg; };
2977
2978     /^-osuf$/       && do { $Osuffix  = &grab_arg_arg(*Args,'-osuf', '');
2979                             if ($Osuffix =~ /\./ ) {
2980                                 print STDERR "$Pgm: -osuf suffix shouldn't contain a .\n";
2981                                 $Status++;
2982                             }
2983                             next arg; };
2984
2985     # -ohi <file>; send the interface to <file>; "-ohi -" to send to stdout
2986     /^-ohi$/        && do { $Specific_hi_file = &grab_arg_arg(*Args,'-ohi', '');
2987                             if ($Specific_hi_file ne '-'
2988                              && $Specific_hi_file =~ /(.*)\/[^\/]*$/) {
2989                                 local($dir_part) = $1;
2990                                 if (! -d $dir_part) {
2991                                     print STDERR "$Pgm: no such directory: $dir_part\n";
2992                                     $Status++;
2993                                 }
2994                             }
2995                             $ProduceHi='-hifile=';
2996                             next arg; };
2997
2998     # The suffix to use when looking for interface files
2999     /^-hisuf$/      && do { $HiSuffix = &grab_arg_arg(*Args,'-hisuf', '');
3000                             if ($HiSuffix =~ /\./ ) {
3001                                 print STDERR "$Pgm: -hisuf suffix shouldn't contain a .\n";
3002                                 $Status++;
3003                             }
3004                             next arg; };
3005     /^-odump$/      && do { $Specific_dump_file = &grab_arg_arg(*Args,'-odump', '');
3006                             if ($Specific_dump_file =~ /(.*)\/[^\/]*$/) {
3007                                 local($dir_part) = $1;
3008                                 if (! -d $dir_part) {
3009                                     print STDERR "$Pgm: no such directory: $dir_part\n";
3010                                     $Status++;
3011                                 }
3012                             }
3013                             next arg; };
3014
3015     #-------------- scc & Profiling Stuff ----------------------------------
3016
3017     /^-prof$/ && do { $PROFing = 'p'; next arg; }; # profiling -- details later!
3018
3019     /^-auto-dicts$/ && do {
3020                 $PROFdicts = '-fauto-sccs-on-dicts';
3021                 next arg; };
3022     /^-auto-all$/ && do {
3023                 $PROFauto = '-fauto-sccs-on-all-toplevs';
3024                 next arg; };
3025     /^-auto$/ && do {
3026                 $PROFauto = '-fauto-sccs-on-exported-toplevs';
3027                 next arg; };
3028
3029     /^-caf-all/ && do { # generate individual CAF SCC annotations
3030                 $PROFcaf = '-fauto-sccs-on-individual-cafs';
3031                 next arg; };
3032
3033     /^-ignore-scc$/ && do {
3034                 # forces ignore of scc annotations even if profiling
3035                 $PROFignore_scc = '-W';
3036                 next arg; };
3037
3038     /^-unprof-scc-auto/ && do {
3039                 # generate auto SCCs on top level bindings when not profiling.
3040                 # Used to measure optimisation effects of presence of sccs.
3041                 $UNPROFscc_auto = ( /-all/ )
3042                             ? '-fauto-sccs-on-all-toplevs'
3043                             : '-fauto-sccs-on-exported-toplevs';
3044                 next arg; };
3045
3046     #--------- ticky/parallel ----------------------------------------------
3047     # we sort out the details a bit later on
3048
3049     /^-gransim$/    && do { $GRANing   = 'g'; &add_syslib('concurrent'); next arg; }; # GranSim
3050     /^-ticky$/      && do { $TICKYing  = 't'; next arg; }; # ticky-ticky
3051     /^-parallel$/   && do { $PARing    = 'p'; &add_syslib('concurrent'); next arg; }; # parallel Haskell
3052     /^-smp$/        && do { $SMPing    = 's'; &add_syslib('concurrent'); next arg; }; # parallel Haskell
3053
3054     #-------------- "user ways" --------------------------------------------
3055
3056     (/^-user-setup-([a-oA-Z])$/ ) &&
3057            do {
3058                 /^-user-setup-([a-oA-Z])$/  && do { $BuildTag = "_$1"; };
3059
3060                 local($stuff) = $UserSetupOpts{$BuildTag};
3061                 local(@opts)  = split(/\s+/, $stuff);
3062
3063                 # feed relevant ops into the arg-processing loop (if any)
3064                 unshift(@Args, @opts) if $#opts >= 0;
3065
3066                 next arg; };
3067
3068     #---------- set search paths for libraries and things ------------------
3069
3070     # we do -i just like HBC (-i clears the list; -i<colon-separated-items>
3071     # prepends the items to the list); -I is for including C .h files.
3072
3073     /^-i$/          && do { @Import_dir = ();  # import path cleared!
3074                             @SysImport_dir = ();
3075                             print STDERR "WARNING: import paths cleared by `-i'\n";
3076                             next arg; };
3077
3078     /^-i(.*)/       && do { local(@new_items);
3079                             local($arg) = $1;
3080
3081                             #
3082                             if ( $arg =~ /;/ ) {
3083                                $SplitMarker=";";
3084                                @new_items = split( /;/, &grab_arg_arg(*Args,'-i', $arg));
3085                             } else {
3086                                @new_items = split( /:/, &grab_arg_arg(*Args,'-i', $arg));
3087                             }
3088                             unshift(@Import_dir, @new_items);
3089                             next arg; };
3090
3091     /^-I(.*)/       && do { push(@Include_dir,     &grab_arg_arg(*Args,'-I', $1)); next arg; };
3092     /^-L(.*)/       && do { push(@UserLibrary_dir, &grab_arg_arg(*Args,'-L', $1)); next arg; };
3093     /^-l(.*)/       && do { push(@UserLibrary,'-l'.&grab_arg_arg(*Args,'-l', $1)); next arg; };
3094
3095     /^-syslib(.*)/  && do { local($syslib) = &grab_arg_arg(*Args,'-syslib',$1);
3096                             &add_syslib($syslib);
3097                             next arg; };
3098
3099     #=======================================================================
3100     # various flags that we can harmlessly send to one program or another
3101     # (we will later "reclaim" some of the compiler ones now sent to gcc)
3102     #=======================================================================
3103
3104     #---------- this driver itself (ghc) -----------------------------------
3105     # these change what executable is run for each phase:
3106     /^-pgmL(.*)$/   && do { $Unlit      = $1; next arg; };
3107     /^-pgmP(.*)$/   && do { $HsCpp      = $1; next arg; };
3108     /^-pgmC(.*)$/   && do { $HsC        = $1; next arg; };
3109     /^-pgmcO?(.*)$/ && do { $CcRegd     = $1; next arg; }; # the O? for back compat
3110     /^-pgma(.*)$/   && do { $As         = $1; next arg; };
3111     /^-pgml(.*)$/   && do { $Lnkr       = $1; next arg; };
3112     /^-pgmdep(.*)$/ && do { $MkDependHS = $1; next arg; };
3113
3114     #---------- the get-anything-through opts (all pgms) -------------------
3115     # these allow arbitrary option-strings to go to any phase:
3116     /^-optL(.*)$/   && do { push(@Unlit_flags,      $1); next arg; };
3117     /^-optP(.*)$/   && do { push(@HsCpp_flags,      $1); next arg; };
3118     /^-optCrts(.*)$/&& do { push(@HsC_rts_flags,    $1); next arg; };
3119     /^-optC(.*)$/   && do { push(@HsC_flags,        $1); next arg; };
3120     /^-optcpp(.*)$/ && do { push(@Cpp_define,       $1); $Only_preprocess_hc = ($1 eq "-E"); next arg; };
3121     /^-optc(.*)$/   && do { push(@CcBoth_flags,     $1); next arg; };
3122     /^-opta(.*)$/   && do { push(@As_flags,         $1); next arg; };
3123     /^-optl(.*)$/   && do { push(@Ld_flags,         $1); next arg; };
3124     /^-optdll(.*)$/ && do { push(@Dll_flags,        $1); next arg; };
3125     /^-optdep(.*)$/ && do { push(@MkDependHS_flags, $1); next arg; };
3126
3127     #---------- Haskell C pre-processor (hscpp) ----------------------------
3128     /^-D(.*)/       && do { push(@HsCpp_flags, "'-D".&grab_arg_arg(*Args,'-D',$1)."'"); next arg; };
3129     /^-U(.*)/       && do { push(@HsCpp_flags, "'-U".&grab_arg_arg(*Args,'-U',$1)."'"); next arg; };
3130
3131     #---------- post-Haskell "assembler"------------------------------------
3132     /^-ddump-raw-asm$/            && do { $Dump_raw_asm        = 1; next arg; };
3133     /^-ddump-asm-splitting-info$/ && do { $Dump_asm_splitting_info = 1; next arg; };
3134
3135     #---------- Haskell compiler (hsc) -------------------------------------
3136
3137     /^-keep-hc-files?-too$/     && do { $Keep_hc_file_too = 1; next arg; };
3138     /^-keep-s-files?-too$/      && do { $Keep_s_file_too = 1;  next arg; };
3139
3140     /^-fignore-interface-pragmas$/ && do { push(@HsC_flags, $_); next arg; };
3141     /^-fignore-asserts$/           && do { push(@HsC_flags, $_); next arg; };
3142
3143     /^-fno-implicit-prelude$/      && do { $NoImplicitPrelude= 1; push(@HsC_flags, $_); next arg; };
3144
3145      #
3146      # have the compiler proper generate concurrent code,
3147      # really only used when you want to configure your own
3148      # special user compilation way.
3149      #
3150      # (ditto for -fgransim, fscc-profiling, -fparallel and -fticky-ticky)
3151      #
3152     /^-fscc-profiling$/   && do { push(@HsC_flags,$_); next arg; };
3153     /^-fticky-ticky$/     && do { push(@HsC_flags,$_); next arg; };
3154     /^-fgransim$/         && do { push(@HsC_flags,$_); next arg; };
3155     /^-fparallel$/        && do { push(@HsC_flags,$_); next arg; };
3156     /^-fsmp$/             && do { push(@HsC_flags,$_); next arg; };
3157
3158     /^-split-objs$/     && do {
3159                         if ( $TargetPlatform !~ /^(alpha|hppa1\.1|i386|m68k|mips|powerpc|rs6000|sparc)-/ ) {
3160                             $SplitObjFiles = 0;
3161                             print STDERR "WARNING: don't know how to split objects on this platform: $TargetPlatform\n`-split-objs' option ignored\n";
3162                         } else {
3163                             $SplitObjFiles = 1;
3164                             $HscOut = '-C=';
3165
3166                             push(@HsC_flags, "-fglobalise-toplev-names");
3167                             push(@CcBoth_flags, '-DUSE_SPLIT_MARKERS');
3168
3169                             require('ghc-split.prl')
3170                              || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-split.prl!\n");
3171                         }
3172                         next arg; };
3173
3174     /^-unreg$/              && do { $UNREGing = 'u'; next arg; };
3175     /^-funregisterised$/    && do { push(@HsC_flags, $_); next arg; };
3176     /^-fno-asm-mangling$/   && do { $DoAsmMangling = 0; next arg; };
3177
3178     /^-fallow-overlapping-instances$/ && do { push(@HsC_flags, $_); next arg; };
3179     /^-fallow-undecidable-instances$/ && do { push(@HsC_flags, $_); next arg; };
3180     /^-fhistory-size.*$/              && do { push(@HsC_flags, $_); next arg; };
3181     /^-fdicts-strict$/                && do { push(@HsC_flags, $_); next arg; };
3182     /^-fglasgow-exts$/
3183                 && do { push(@HsC_flags, $_);
3184
3185                         # -fglasgow-exts implies -syslib lang
3186                         &add_syslib('lang');
3187
3188                         next arg; };
3189
3190     /^-fspeciali[sz]e$/
3191                 && do { $Oopt_DoSpecialise = '-fspecialise'; next arg; };
3192     /^-fno-speciali[sz]e$/
3193                 && do { $Oopt_DoSpecialise = ''; next arg; };
3194
3195     /^-fusagesp$/
3196                 && do {  $Oopt_UsageSPInf = '-fusagesp';
3197                          push (@HsC_flags, '-fusagesp-on'); next arg; };
3198
3199     /^-fcompiling-prelude$/ && do { $CompilingPrelude=1; push(@HsC_flags, $_); next arg; };
3200
3201 # Now the foldr/build options, which are *on* by default (for -O).
3202
3203     /^-ffoldr-build$/
3204                     && do { $Oopt_FoldrBuild = 1;
3205                             #print "Yes F/B\n";
3206                             next arg; };
3207
3208     /^-fno-foldr-build$/
3209                     && do { $Oopt_FoldrBuild = 0;
3210                             next arg; };
3211
3212     # --------------- Renamer -------------
3213
3214
3215     /^-fno-prune-tydecls$/     && do { push(@HsC_flags, $_); next arg; };
3216     /^-fno-prune-instdecls$/     && do { push(@HsC_flags, $_); next arg; };
3217
3218     # ---------------
3219
3220     /^-fasm-(.*)$/  && do { $HscOut = '-S='; next arg; }; # force using nativeGen
3221     /^-fvia-[cC]$/          && do { $HscOut = '-C='; next arg; }; # force using C compiler
3222
3223     # ---------------
3224
3225     /^-funfolding-.*$/
3226                     && do { push(@HsC_flags, $_); next arg };
3227
3228     /^-fliberate-case-.*$/
3229                     && do { push(@HsC_flags, $_); next arg };
3230
3231     /^-funfold-casms-in-hi-file$/
3232                     && do { push(@HsC_flags, $_); next arg };
3233
3234     /^(-fmax-simplifier-iterations)(.*)$/
3235                     && do { $Oopt_MaxSimplifierIterations = $1 . &grab_arg_arg(*Args,$1, $2);
3236                             next arg; };
3237
3238     /^-fno-pedantic-bottoms$/
3239                     && do { $Oopt_PedanticBottoms = ''; next arg; };
3240
3241     /^-fno-pre-inlining$/
3242                     && do { push(@HsC_flags, $_); next arg };
3243
3244     /^-fno-let-from-(case|app|strict-let)$/ # experimental, really (WDP 95/10)
3245                     && do { push(@HsC_flags, $_); next arg; };
3246
3247     /^-funbox-strict-fields$/
3248                    && do { push(@HsC_flags, $_); next arg; };
3249
3250     # --------------- Warnings etc. ------
3251
3252     /^-fwarn-(.*)$/      && do { push(@HsC_flags, $_); next arg; };
3253
3254     /^-fno-(.*)$/   && do { push(@HsC_antiflags, "-f$1");
3255                             &squashHscFlag("-f$1");
3256                             next arg; };
3257
3258     /^-W$/          && do { push(@HsC_flags, @MinusWOpts); next arg; };
3259     /^-Wall$/       && do { push(@HsC_flags, @MinusWallOpts); next arg; };
3260     /^(-Wnot|w)$/   && do { foreach (@Hsc_flags) {
3261                                 /^-fwarn-(.*)$/ && do { $_=''; };
3262                             };
3263                             push(@HsC_antiflags, @StandardWarnings);
3264                             next arg; };
3265
3266     # --------------- fun stuff ----------------
3267
3268     /^-freport-compile$/ && do { push(@HsC_flags, $_); next arg; };
3269
3270     # --------------- platform specific flags (for gcc mostly) ----------------
3271
3272     /^-mlong-calls$/ && do { # for GCC for HP-PA boxes,
3273                              # for 2.6.x..?, does not apply for 2.7.2
3274                              # any longer.
3275                             unshift(@CcBoth_flags, ( $_ ));
3276                             next arg; };
3277
3278     /^-m(v8|sparclite|cypress|supersparc|cpu=(cypress|supersparc))$/
3279                      && do { # for GCC for SPARCs
3280                             unshift(@CcBoth_flags, ( $_ ));
3281                             next arg; };
3282
3283     /^-monly-([432])-regs/ && do { # for iX86 boxes only; no effect otherwise
3284                             $StolenX86Regs = $1;
3285                             next arg; };
3286
3287     #*************** ... and lots of debugging ones (form: -d* )
3288
3289     # -d(no-)core-lint is done this way so it is turn-off-able.
3290     /^-dcore-lint/       && do { $CoreLint = '-dcore-lint'; next arg; };
3291     /^-dno-core-lint/    && do { $CoreLint = '';            next arg; };
3292     # Ditto for USP lint
3293     /^-dusagesp-lint/    && do { $USPLint = '-dusagesp-lint'; next arg; };
3294     /^-dno-usagesp-lint/ && do { $USPLint = '';               next arg; };
3295     # Ditto for STG lint
3296     /^-dstg-lint/       && do { $StgLint = '-dstg-lint'; next arg; };
3297     /^-dno-stg-lint/    && do { $StgLint = '';           next arg; };
3298
3299     /^-d(dump|ppr)-/         && do { push(@HsC_flags, $_); next arg; };
3300     /^-dverbose-(simpl|stg)/ && do { push(@HsC_flags, $_); next arg; };
3301     /^-dshow-passes/         && do { push(@HsC_flags, $_); next arg; };
3302     /^-dshow-rn-stats/       && do { push(@HsC_flags, $_); next arg; };
3303     /^-dshow-rn-trace/       && do { push(@HsC_flags, $_); next arg; };
3304     /^-dsource-stats/        && do { push(@HsC_flags, $_); next arg; };
3305     /^-dsimplifier-stats/    && do { push(@HsC_flags, $_); next arg; };
3306     /^-dstg-stats/           && do { $Oopt_StgStats = $_; next arg; };
3307
3308     #*************** ... and now all these -R* ones for its runtime system...
3309
3310     /^-Rscale-sizes?(.*)/ && do {
3311         $Scale_sizes_by = &grab_arg_arg(*Args,'-Rscale-sizes', $1);
3312         next arg; };
3313
3314     /^(-H|-Rmax-heapsize)(.*)/ && do {
3315         local($heap_size) = &grab_arg_arg(*Args,$1, $2);
3316         if ($heap_size =~ /(\d+)[Kk]$/) {
3317             $heap_size = $1 * 1000;
3318         } elsif ($heap_size =~ /(\d+)[Mm]$/) {
3319             $heap_size = $1 * 1000 * 1000;
3320         } elsif ($heap_size =~ /(\d+)[Gg]$/) {
3321             $heap_size = $1 * 1000 * 1000 * 1000;
3322         }
3323         if ($heap_size <= 0) {
3324             print STDERR "$Pgm: resetting heap-size to zero!!! $heap_size\n";
3325             $Specific_heap_size = 0;
3326
3327         # if several heap sizes given, take the largest...
3328         } elsif ($heap_size >= $Specific_heap_size) {
3329             $Specific_heap_size = $heap_size;
3330         } else {
3331             print STDERR "$Pgm: ignoring heap-size-setting option ($_)...not the largest seen\n" if $Verbose;
3332         }
3333         next arg; };
3334
3335     /^(-K|Rmax-(stk|stack)size)(.*)/ && do {
3336         local($flag) = $1;
3337         local($stk_size) = &grab_arg_arg(*Args,'-Rmax-stksize', $3);
3338         if ($stk_size =~ /(\d+)[Kk]$/) {
3339             $stk_size = $1 * 1000;
3340         } elsif ($stk_size =~ /(\d+)[Mm]$/) {
3341             $stk_size = $1 * 1000 * 1000;
3342         } elsif ($stk_size =~ /(\d+)[Gg]$/) {
3343             $stk_size = $1 * 1000 * 1000 * 1000;
3344         }
3345         if ($stk_size <= 0) {
3346             print STDERR "$Pgm: resetting stack-size to zero!!! $stk_size\n";
3347             $Specific_stk_size = 0;
3348
3349         # if several stack sizes given, take the largest...
3350         } elsif ($stk_size >= $Specific_stk_size) {
3351             $Specific_stk_size = $stk_size;
3352         } else {
3353             print STDERR "$Pgm: ignoring stack-size-setting option ($flag $stk_size)...not the largest seen\n" if $Verbose;
3354         }
3355         next arg; };
3356
3357     /^-Rgc-stats$/ && do {  $CollectingGCstats++;
3358                             # the two RTSs do this diff ways; we will try to compensate
3359                             next arg; };
3360
3361     /^-Rghc-timing/ && do { $CollectGhcTimings = 1; next arg; };
3362
3363     #---------- C high-level assembler (gcc) -------------------------------
3364     /^-(Wall|ansi|pedantic)$/ && do { push(@CcBoth_flags, $_); next arg; };
3365
3366     # -dgcc-lint is a useful way of making GCC very fussy.
3367     # From alan@spri.levels.unisa.edu.au (Alan Modra).
3368     /^-dgcc-lint$/ && do { push(@CcBoth_flags, '-Wall -Wpointer-arith -Wbad-function-cast -Wcast-qual -Wstrict-prototypes -Wmissing-prototypes -Wmissing-declarations -Wnested-externs'); next arg; };
3369     # An alternate set, from mark@sgcs.com (Mark W. Snitily)
3370     # -Wall -Wstrict-prototypes -Wmissing-prototypes -Wcast-align -Wshadow
3371
3372     # inject "#include <wurble>" into the compiler's C output!
3373
3374     /^-#include(.*)/    && do {
3375         local($to_include) = &grab_arg_arg(*Args,'-#include', $1);
3376         push(@CcInjects, "#include $to_include\n");
3377         next arg; };
3378
3379     #---------- Linker (gcc, really) ---------------------------------------
3380
3381     /^-static$/         && do { $Static=1; push(@Ld_flags, $_); next arg; };
3382     /^-no-hs-main$/     && do { $NoHaskellMain=1; next arg;    };
3383
3384     #---------- mixed cc and linker magic ----------------------------------
3385     # this optimisation stuff is finally sorted out later on...
3386
3387     /^-O2-for-C$/ && do { $MinusO2ForC = 1; next arg; };
3388
3389     /^-O[1-2]?$/ && do {
3390                 local($opt_lev) = ( /^-O2$/ ) ? 2 : 1; # max 'em
3391                 $OptLevel = ( $opt_lev > $OptLevel ) ? $opt_lev : $OptLevel;
3392
3393                 $HscOut = '-C=' if $OptLevel == 2; # force use of C compiler
3394                 next arg; };
3395
3396     /^-Onot$/   && do { $OptLevel = 0; next arg; }; # # set it to <no opt>
3397
3398     /^-Ofile(.*)/ && do {
3399                 $OptLevel = 3;
3400                 local($ofile) = &grab_arg_arg(*Args,'-Ofile', $1);
3401                 @HsC_minusO3_flags = ();
3402
3403                 open(OFILE, "< $ofile") || die "Can't open $ofile!\n";
3404                 while (<OFILE>) {
3405                     chop;
3406                     s/\#.*//;       # death to comments
3407                     s/[ \t]+//g;    # death to whitespace
3408                     next if /^$/;   # ditto, blank lines
3409                     s/([()*{}])/\\$1/g;    # protect shell metacharacters
3410                     if ( /^C:(.*)/ ) {
3411                         push(@CcBoth_flags, $1);
3412                     } else {
3413                         push(@HsC_minusO3_flags, $_);
3414                     }
3415                 }
3416                 close(OFILE);
3417                 next arg; };
3418
3419     /^-debug$/  && do { # all this does is mark a .hc/.o as "debugging"
3420                         # in the consistency info
3421                         $DEBUGging = 'd';
3422                         next arg; };
3423
3424     #---------- linking .a file --------------------------------------------
3425
3426     /^-Main(.*)/ && do {
3427                 # specifies main or mainPrimIO to be linked
3428                 $Ld_main = $1;
3429                 next arg; };
3430
3431     #---------- catch unrecognized flags -----------------------------------
3432
3433     /^-./ && do {
3434         print STDERR "$Pgm: unrecognised option: $_\n";
3435         $Status++;
3436         next arg; };
3437
3438 }
3439
3440 } # end of processArgs
3441
3442 \end{code}