ghc/driver/ghc.lprl

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