ghc/driver/ghc.lprl

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