ghc/driver/ghc.lprl

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