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