ghc/driver/ghc.lprl

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