ghc/driver/ghc.lprl

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