ghc/driver/ghc.lprl

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