ghc/driver/ghc.lprl

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