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