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