ghc/driver/ghc.lprl

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