ghc/driver/ghc.lprl

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