ghc/driver/ghc.lprl

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