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