ghc/driver/ghc.lprl

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