ghc/driver/ghc.lprl

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