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