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