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-|^rs6000-/) {
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   } elsif ($TargetPlatform =~ /^sparc-/) {
1226       # we know how to *mangle* asm for SPARC
1227       unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1228       unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK;
1229
1230   }
1231 } # end of setupMachOpts
1232 \end{code}
1233
1234 Same unshifting magic, but for special linker flags.
1235
1236 The configure script determines whether the object file symbol tables
1237 have a leading underscore, and sets @LeadingUnderscore@ accordingly.
1238 (The driver script `sees' the setting of the @LeadingUnderscore@
1239 by having the Makefile prepend it).
1240
1241 \begin{code}
1242 sub setupLinkOpts {
1243   local($uscore) = ( ${LeadingUnderscore} eq 'YES' ) ? '_' : '';
1244
1245   unshift(@Ld_flags,
1246         (($Ld_main) ? ( '-u', "${uscore}Main_" . $Ld_main . '_closure' ) : ()));
1247   unshift(@Ld_flags,
1248         (  '-u', "${uscore}PrelBase_Z91Z93_closure"      # i.e., []
1249           ,'-u', "${uscore}PrelBase_IZh_static_info"
1250           ,'-u', "${uscore}PrelBase_CZh_static_info"
1251           ,'-u', "${uscore}PrelBase_False_inregs_info"
1252           ,'-u', "${uscore}PrelBase_True_inregs_info"
1253           ,'-u', "${uscore}STBase_SZh_static_info"
1254           ,'-u', "${uscore}DEBUG_REGS"
1255         ));
1256   if ($TargetPlatform =~ /^powerpc-|^rs6000-/) {
1257     # sometimes we have lots of toc entries...
1258     #  unshift(@Ld_flags, ('-Xlinker -bbigtoc -Xlinker -bnoquiet'));
1259     unshift(@Ld_flags, ('-Xlinker -bbigtoc'));
1260   }
1261
1262 } # end of setupLinkOpts
1263
1264 \end{code}
1265
1266 %************************************************************************
1267 %*                                                                      *
1268 \subsection{Set up include paths and system-library enslurpment}
1269 %*                                                                      *
1270 %************************************************************************
1271
1272 Now that we know what garbage-collector, etc., are required, we can
1273 finalise our list of libraries to slurp through, and generally Get
1274 Ready for Business.
1275
1276 \begin{code}
1277 sub setupIncPaths {
1278   # default includes must be added AFTER option processing
1279   if ( ! $INSTALLING ) {
1280       push (@Include_dir, "$TopPwd/${CURRENT_DIR}/${GHC_INCLUDE_DIR}");
1281   } else {
1282       push (@Include_dir, "$InstLibDirGhc/includes");
1283       push (@Include_dir, "$InstLibDirGhc/includes");
1284   }
1285 } # end of setupIncPaths
1286 \end{code}
1287
1288 \begin{code}
1289 sub setupSyslibs {
1290   push(@SysLibrary, ( '-lHS', '-lHS_cbits' )); # basic I/O and prelude stuff
1291
1292   local($f);
1293   foreach $f (@SysLibrary) {
1294       next if $f =~ /_cbits/;
1295       $f .= $BuildTag if $f =~ /^-lHS/;
1296   }
1297
1298   # fiddle the TopClosure file name...
1299   $TopClosureFile =~ s/XXXX//;
1300
1301   # Push library HSrts, plus boring clib bit
1302   push(@SysLibrary, "-lHSrts${BuildTag}");
1303   push(@SysLibrary, '-lHSclib');
1304   #
1305   # RTS compiled with cygwin32, uses the WinMM API
1306   # to implement the itimers, since cygwin.dll does not
1307   # support it. Only reqd. for `ways' that use itimers.
1308   #
1309   push(@SysLibrary, '-lwinmm') if $BuildTag ne '' && $TargetPlatform eq 'i386-unknown-cygwin32';
1310
1311   # Push the pvm libraries
1312   if ($BuildTag eq '_mp') {
1313       $pvmlib = "$ENV{'PVM_ROOT'}/lib/$ENV{'PVM_ARCH'}";
1314       push(@SysLibrary, "-L$pvmlib", '-lpvm3', '-lgpvm3');
1315       if ( $ENV{'PVM_ARCH'} eq 'SUNMP' ) {
1316           push(@SysLibrary, '-lthread', '-lsocket', '-lnsl');
1317       } elsif ( $ENV{'PVM_ARCH'} eq 'SUN4SOL2' ) {
1318           push(@SysLibrary, '-lsocket', '-lnsl');
1319       }
1320   }
1321
1322 # Push the GNU multi-precision arith lib; and the math library
1323 push(@SysLibrary, '-lgmp');
1324 push(@SysLibrary, '-lm');
1325 \end{code}
1326
1327 %************************************************************************
1328 %*                                                                      *
1329 \subsection{Check that this system was built to do what we are asking}
1330 %*                                                                      *
1331 %************************************************************************
1332
1333 Before continuing we check that the appropriate build is available.
1334
1335 \begin{code}
1336 #die "$Pgm: no BuildAvail?? $BuildTag\n" if $BuildDescr{$BuildTag} eq '' ; # sanity
1337
1338 if ( $BuildDescr{$BuildTag} eq '' ) {
1339     print STDERR "$Pgm: a `", $BuildDescr{$BuildTag},
1340         "' \"build\" is not available with your GHC setup.\n";
1341     print STDERR "(It was not configured for it at your site.)\n";
1342     print STDERR $ShortUsage;
1343     exit 1;
1344 }
1345
1346 } # end of setupSyslibs
1347
1348 \end{code}
1349
1350 %************************************************************************
1351 %*                                                                      *
1352 \subsection{Final miscellaneous setup bits before we start going}
1353 %*                                                                      *
1354 %************************************************************************
1355
1356 Record largest specific heapsize, if any.
1357 \begin{code}
1358 sub setupHeapStackSize {
1359    $Specific_heap_size = $Specific_heap_size * $Scale_sizes_by;
1360    push(@HsC_rts_flags, '-H'.$Specific_heap_size);
1361    $Specific_stk_size = $Specific_stk_size * $Scale_sizes_by;
1362    push(@HsC_rts_flags, "-K$Specific_stk_size");
1363 }
1364 \end{code}
1365
1366 If no input or link files seen, then we let 'em feed in stdin; this is
1367 mainly for debugging.
1368
1369 \begin{code}
1370
1371 if ($#Input_file < 0 && $#Link_file < 0) {
1372     @Input_file = ( '-' );
1373
1374     open(INF, "> $Tmp_prefix.hs") || &tidy_up_and_die(1,"Can't open $Tmp_prefix.hs\n");
1375     print STDERR "Enter your Haskell program, end with ^D (on a line of its own):\n";
1376     while (<>) { print INF $_; }
1377     close(INF) || &tidy_up_and_die(1,"Failed writing to $Tmp_prefix.hs\n");
1378 }
1379
1380 \end{code}
1381
1382 Tell the world who we are, if they asked.
1383 \begin{code}
1384 print STDERR "${PROJECTNAME}, version ${PROJECTVERSION}, patchlevel ${PROJECTPATCHLEVEL}\n"
1385     if $Verbose;
1386 \end{code}
1387
1388 %************************************************************************
1389 %*                                                                      *
1390 \section[Driver-main-loop]{Main loop: Process input files, and link if required}
1391 %*                                                                      *
1392 %************************************************************************
1393
1394 Process the input files; don't continue with linking if there are
1395 problems (global variable @$Status@ non-zero).
1396 \begin{code}
1397 foreach $ifile (@Input_file) {
1398     &ProcessInputFile($ifile);
1399 }
1400
1401 if ( $Status > 0 ) { # don't link if there were errors...
1402     print STDERR $ShortUsage;
1403     &tidy_up();
1404     exit $Status;
1405 }
1406
1407 # append last minute flags linker and consistency flags
1408 &setupBuildFlags();
1409 &setupSyslibs();
1410 &setupLinkOpts();
1411
1412 \end{code}
1413
1414 Link if appropriate.
1415 \begin{code}
1416 if ($Do_lnkr) {
1417     local($libdirs) = '';
1418
1419     # glue them together:
1420     push(@UserLibrary_dir, @SysLibrary_dir);
1421
1422     $libdirs = '-L' . join(' -L',@UserLibrary_dir) if $#UserLibrary_dir >= 0;
1423
1424     # for a linker, use an explicitly given one, or the going C compiler ...
1425     local($lnkr) = ( $Lnkr ) ? $Lnkr : $CcRegd;
1426
1427     local($output) = ($Specific_output_file ne '') ? "-o $Specific_output_file" : '';
1428     @Files_to_tidy = ($Specific_output_file ne '') ? $Specific_output_file : 'a.out';
1429
1430     local($to_do) = "$lnkr $Verbose @Ld_flags $output @Link_file $TopClosureFile $libdirs @UserLibrary @SysLibrary";
1431     &run_something($to_do, 'Linker');
1432
1433     # finally, check the consistency info in the binary
1434     local($executable) = $Files_to_tidy[0];
1435     @Files_to_tidy = (); # reset; we don't want to nuke it if it's inconsistent
1436
1437     if ( $LinkChk ) {
1438         # dynamically load consistency-chking code; then do it.
1439         require('ghc-consist.prl')
1440             || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-consist.prl!\n");
1441
1442         &chk_consistency_info ( $executable );
1443     }
1444
1445     # if PVM parallel stuff, we do truly weird things.
1446     # Essentially: (1) move the executable over to where PVM expects
1447     # to find it.  (2) create a script in place of the executable
1448     # which will cause the program to be run, via SysMan.
1449     if ( $PARing eq 'p' ) {
1450         local($pvm_executable) = $executable;
1451         local($pvm_executable_base);
1452
1453         if ( $pvm_executable !~ /^\// ) { # a relative path name: make absolute
1454             local($pwd) = `pwd`;
1455             chop($pwd);
1456             $pwd =~ s/^\/tmp_mnt//;
1457             $pvm_executable = "$pwd/$pvm_executable";
1458         }
1459
1460         $pvm_executable =~ s|/|=|g; # make /s into =s
1461         $pvm_executable_base = $pvm_executable;
1462
1463         $pvm_executable = $ENV{'PVM_ROOT'} . '/bin/' . $ENV{'PVM_ARCH'}
1464                         . "/$pvm_executable";
1465
1466         &run_something("$Rm -f $pvm_executable; $Cp -p $executable $pvm_executable && $Rm -f $executable", 'Moving binary to PVM land');
1467
1468         # OK, now create the magic script for "$executable"
1469         open(EXEC, "> $executable") || &tidy_up_and_die(1,"$Pgm: couldn't open $executable to write!\n");
1470         print EXEC <<EOSCRIPT1;
1471 eval 'exec perl -S \$0 \${1+"\$@"}'
1472   if \$running_under_some_shell;
1473 # =!=!=!=!=!=!=!=!=!=!=!
1474 # This script is automatically generated: DO NOT EDIT!!!
1475 # Generated by Glasgow Haskell, version ${PROJECTVERSION} ${PROJECTPATCHLEVEL}
1476 #
1477 \$pvm_executable      = '$pvm_executable';
1478 \$pvm_executable_base = '$pvm_executable_base';
1479 \$SysMan = '$SysMan';
1480 EOSCRIPT1
1481
1482         print EXEC <<\EOSCRIPT2;
1483 # first, some magical shortcuts to run "commands" on the binary
1484 # (which is hidden)
1485 if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {
1486     local($cmd) = $1;
1487     system("$cmd $pvm_executable");
1488     exit(0); # all done
1489 }
1490
1491 # OK, really run it; process the args first
1492 $ENV{'PE'} = $pvm_executable_base;
1493 $debug = '';
1494 $nprocessors = 2; # the default
1495 @nonPVM_args = ();
1496 $in_RTS_args = 0;
1497
1498 # ToDo: handle --RTS
1499 args: while ($a = shift(@ARGV)) {
1500     if ( $a eq '+RTS' ) {
1501         $in_RTS_args = 1;
1502     } elsif ( $a eq '-RTS' ) {
1503         $in_RTS_args = 0;
1504     }
1505     if ( $a eq '-d' && $in_RTS_args ) {
1506         $debug = '-';
1507     } elsif ( $a =~ /^-N(\d+)/ && $in_RTS_args ) {
1508         $nprocessors = $1;
1509     } else {
1510         push(@nonPVM_args, $a);
1511     }
1512 }
1513
1514 local($return_val) = 0;
1515 system("$SysMan $debug $pvm_executable $nprocessors @nonPVM_args");
1516 $return_val = $?;
1517 system("mv $ENV{'HOME'}/$pvm_executable_base.???.gr .") if -f "$ENV{'HOME'}/$pvm_executable_base.001.gr";
1518 exit($return_val);
1519 EOSCRIPT2
1520         close(EXEC) || die "Failed closing $executable\n";
1521         chmod 0755, $executable;
1522     }
1523 }
1524
1525 # that...  that's all, folks!
1526 &tidy_up();
1527 exit $Status; # will still be 0 if all went well
1528 \end{code}
1529
1530 %************************************************************************
1531 %*                                                                      *
1532 \section[Driver-do-one-file]{How to process a single input file}
1533 %*                                                                      *
1534 %************************************************************************
1535
1536 \begin{code}
1537 sub ProcessInputFile {
1538     local($ifile) = @_;   # input file name
1539     local($ifile_root);   # root of or basename of input file
1540     local($ofile_target); # ultimate output file we hope to produce
1541                           # from input file (need to know for recomp
1542                           # checking purposes)
1543     local($hifile_target);# ditto (but .hi file)
1544 \end{code}
1545
1546 Handle the weirdity of input from stdin.
1547 \begin{code}
1548     if ($ifile ne '-') {
1549         ($ifile_root  = $ifile) =~ s/\.[^\.\/]+$//;
1550         $ofile_target = # may be reset later...
1551                         ($Specific_output_file ne '' && ! $Do_lnkr)
1552                         ? $Specific_output_file
1553                         : &odir_ify($ifile_root, 'o');
1554         $hifile_target= ($Specific_hi_file ne '')
1555                         ? $Specific_hi_file
1556                         : "$ifile_root.$HiSuffix"; # ToDo: odirify?
1557                         # NB: may change if $ifile_root isn't module name (??)
1558     } else {
1559         $ifile = "$Tmp_prefix.hs"; # we know that's where we put the input
1560         $ifile_root   = '_stdin';
1561         $ofile_target = '_stdout'; # gratuitous?
1562         $hifile_target= '_stdout'; # ditto?
1563     }
1564 \end{code}
1565
1566 We need to decide what phases of the compilation system we will run
1567 over this file.  The defaults are the ones established when processing
1568 flags.  (That established what the last phase run for all files is.)
1569
1570 We do the pre-recompilation-checker phases here; the rest later.
1571 \begin{code}
1572 \end{code}
1573
1574 Look at the suffix and decide what initial phases of compilation may
1575 be dropped off for this file.  Also the rather boring business of
1576 which files are coming-in/going-out.
1577
1578 Again, we'll do the post-recompilation-checker parts of this later.
1579 \begin{code}
1580     local($do_lit2pgm)  = ($ifile =~ /\.lhs$/) ? 1 : 0;
1581     local($do_hscpp)    = 1; # but "hscpp" might really be "cat"
1582     local($do_hsc)      = 1;
1583
1584     # names of the files to stuff between phases
1585     # defaults are temporaries
1586     local($in_lit2pgm)    = $ifile;
1587     local($lit2pgm_hscpp) = "$Tmp_prefix.lpp";
1588     local($hscpp_hsc)     = "$Tmp_prefix.cpp";
1589     local($hsc_hi)        = "$Tmp_prefix.hi";
1590     local($cc_as_o)       = "${Tmp_prefix}_o.s"; # temporary for raw .s file if opt C
1591     local($cc_as)         = "$Tmp_prefix.s";     # mangled or hsc-produced .s code
1592     local($as_out)        = $ofile_target;
1593
1594     local($is_hc_file) = 1; #Is the C code .hc or .c? Assume .hc for now
1595
1596     # OK, let's strip off some literate junk..
1597     if ($ifile =~ /\.lhs$/) {
1598         &runLit2pgm($in_lit2pgm, $lit2pgm_hscpp)
1599     } else {
1600         $lit2pgm_hscpp = $ifile;
1601     }
1602
1603     #
1604     @File_options = ();
1605
1606     # Scan the top of the de-litted file for {-# OPTIONS #-} pragmas
1607     &check_for_source_options($lit2pgm_hscpp,$ifile);
1608     # options found in the source file take a back seat, i.e., we scan
1609     # them first. Only process the command line again if source file
1610     # contained anything of interest *or* there's more than one
1611     # input file (we have to reset the options).
1612     #
1613     if ( $#Input_file >= 0 || $#File_options >= 0) {
1614         #@File_options = (@File_options, @Cmd_opts);
1615
1616         # Now process the command line
1617         &initDriverGlobals();
1618         &processArgs((@File_options,@Cmd_opts));
1619         print STDERR "\nEffective command line: " .
1620                      join(' ',(@File_options,@Cmd_opts)) . "\n" if $Verbose;
1621     }
1622     #
1623     # Having got the effective command line scanned, set up
1624     # the various options in prep for some real work.
1625     #
1626     # check the sanity of the BuildTag we're about to use,
1627     # and if needs be, add some more flags and setup to
1628     # the different phases.
1629     #
1630     &setupBuildFlags();
1631     &setupOptimiseFlags();
1632     &setupMachOpts();
1633     &setupIncPaths();
1634     &setupHeapStackSize();
1635
1636     #
1637     # These two variables need to be set after the
1638     # command-line has been processed and the build options
1639     # have be seen set up. This is because command-line options
1640     # can control whether to compile vias C or not.
1641     #
1642     local($do_cc)       = ( $Do_cc != -1) # i.e., it was set explicitly
1643                           ? $Do_cc
1644                           : ( ($HscOut eq '-C=') ? 1 : 0 );
1645     local($do_as)       = $Do_as;
1646     local($hsc_out)       = ( $HscOut eq '-C=' ) ? "$Tmp_prefix.hc" : "$Tmp_prefix.s" ;
1647
1648     if ($ifile =~ /.lhs$/ || $ifile =~ /.hs$/ ) {
1649        ;
1650     } elsif ($ifile =~ /\.hc$/ || $ifile =~ /_hc$/ ) { # || $ifile =~ /\.$Isuffix$/o) # ToDo: better
1651         $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
1652         $hsc_out = $ifile;
1653     } elsif ($ifile =~ /\.c$/) {
1654         $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
1655         $hsc_out = $ifile; $is_hc_file = 0;
1656     } elsif ($ifile =~ /\.s$/) {
1657         $do_hscpp = 0; $do_hsc = 0; $do_cc = 0;
1658         $cc_as = $ifile;
1659     } else { # don't know what it is, but nothing to do herein...
1660         $do_hscpp = 0; $do_hsc = 0; $do_cc = 0; $do_as = 0;
1661     }
1662
1663     # hack to avoid running hscpp
1664     $HsCpp = $Cat if ! $Cpp_flag_set;
1665
1666     &runHscpp($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc)
1667         if $do_hscpp;
1668 \end{code}
1669
1670 We now think about whether to run hsc/cc or not (when hsc produces .s
1671 stuff, it effectively takes the place of both phases).
1672
1673 To get the output file name right: for each phase that we are {\em
1674 not} going to run, set its input (i.e., the output of its preceding
1675 phase) to @"$ifile_root.<suffix>"@.
1676 \begin{code}
1677     local($going_interactive) = $HscOut eq '-N=' || $ifile_root eq '_stdin';
1678
1679     #
1680     # Warning issued if -keep-hc-file-too is used without
1681     # -fvia-C (or the equivalent)
1682     #
1683     if ( $HscOut ne '-C=' && $Keep_hc_file_too ) {
1684         print STDERR "Warning: Native code generator to be used, -keep-hc-file-too will be ignored\n";
1685     }
1686
1687     if (! $do_cc && ! $do_as) { # stopping after hsc
1688         $hsc_out = ($Specific_output_file ne '')
1689                  ? $Specific_output_file
1690                  : &odir_ify($ifile_root, ($HscOut eq '-C=') ? 'hc' : 's');
1691
1692         $ofile_target = $hsc_out; # reset
1693     }
1694
1695     if (! $do_as) { # stopping after gcc (or hsc)
1696         $cc_as = ($Specific_output_file ne '')
1697                  ? $Specific_output_file
1698                  : &odir_ify($ifile_root, ( $Only_preprocess_C ) ? 'i' : 's');
1699
1700         $ofile_target = $cc_as; # reset
1701     }
1702
1703 \end{code}
1704
1705
1706 Now the Haskell compiler, C compiler, and assembler
1707
1708 \begin{code}
1709    if ($do_hsc) {
1710         &runHscAndProcessInterfaces( $ifile, $hscpp_hsc, $ifile_root,
1711                                      $ofile_target, $hifile_target);
1712     }
1713
1714     if ($do_cc) {
1715         &runGcc    ($is_hc_file, $hsc_out, $cc_as_o);
1716         &runMangler($is_hc_file, $cc_as_o, $cc_as, $ifile_root);
1717     }
1718
1719     &split_asm_file($cc_as)  if $do_as && $SplitObjFiles;
1720
1721     # save a copy of the .s file..
1722     &saveIntermediate($ifile_root , "s" , $cc_as) if ($do_as && $Keep_s_file_too);
1723     &runAs($as_out, $ifile_root) if $do_as;
1724 \end{code}
1725
1726 Finally, decide what to queue up for linker input.
1727 \begin{code}
1728     # tentatively assume we will eventually produce linker input:
1729     push(@Link_file, &odir_ify($ifile_root, 'o'));
1730
1731 #ToDo:    local($or_isuf) = ($Isuffix eq '') ? '' : "|$Isuffix";
1732
1733     if ( $ifile !~ /\.(lhs|hs|hc|c|s)$/ && $ifile !~ /_hc$/ ) {
1734         print STDERR "$Pgm: don't recognise suffix on `$ifile'; passing it through to linker\n"
1735             if $ifile !~ /\.a$/;
1736
1737         # oops; we tentatively pushed the wrong thing; fix & do the right thing
1738         pop(@Link_file); push(@Link_file, $ifile);
1739     }
1740
1741
1742 } # end of ProcessInputFile
1743 \end{code}
1744
1745 %************************************************************************
1746 %*                                                                      *
1747 \section[Driver-run-phases]{Routines to run the various phases}
1748 %*                                                                      *
1749 %************************************************************************
1750
1751 \begin{code}
1752 sub runLit2pgm {
1753     local($in_lit2pgm, $lit2pgm_hscpp) = @_;
1754
1755     local($to_do) = "echo '#line 1 \"$in_lit2pgm\"' > $lit2pgm_hscpp && ".
1756                     "$Unlit @Unlit_flags $in_lit2pgm -  >> $lit2pgm_hscpp";
1757     @Files_to_tidy = ( $lit2pgm_hscpp );
1758
1759     &run_something($to_do, 'literate pre-processor');
1760 }
1761 \end{code}
1762
1763 \begin{code}
1764 sub runHscpp {
1765     local($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc) = @_;
1766
1767     local($to_do);
1768
1769     if ($HsCpp eq $Cat) {
1770         $to_do = "echo '#line 1 \"$in_lit2pgm\"' > $hscpp_hsc && ".
1771                         "$HsCpp $lit2pgm_hscpp >> $hscpp_hsc";
1772         @Files_to_tidy = ( $hscpp_hsc );
1773         &run_something($to_do, 'Ineffective C pre-processor');
1774     } else {
1775         local($includes) = '-I' . join(' -I',@Include_dir);
1776         $to_do = "echo '#line 1 \"$in_lit2pgm\"' > $hscpp_hsc && ".
1777                         "$HsCpp $Verbose $genSPECS_flag @HsCpp_flags -D__HASKELL1__=$Haskell1Version -D__GLASGOW_HASKELL__=$GhcVersionInfo $includes $lit2pgm_hscpp >> $hscpp_hsc";
1778         @Files_to_tidy = ( $hscpp_hsc );
1779         &run_something($to_do, 'Haskellised C pre-processor');
1780     }
1781 }
1782 \end{code}
1783
1784
1785 \begin{code}
1786 sub runHscAndProcessInterfaces {
1787     local($ifile, $hscpp_hsc, $ifile_root, $ofile_target, $hifile_target) = @_;
1788
1789         # $ifile                is the original input file
1790         # $hscpp_hsc            post-unlit, post-cpp, etc., input file
1791         # $ifile_root           input filename minus suffix
1792         # $ofile_target         the output file that we ultimately hope to produce
1793         # $hifile_target        the .hi file ... (ditto)
1794
1795     local($source_unchanged) = 1;
1796
1797     # Check if the source file is up to date relative to the target; in
1798     # that case we say "source is unchanged" and let the compiler bail out
1799     # early if the import usage information allows it.
1800
1801     ($i_dev,$i_ino,$i_mode,$i_nlink,$i_uid,$i_gid,$i_rdev,$i_size,
1802      $i_atime,$i_mtime,$i_ctime,$i_blksize,$i_blocks) = stat($ifile);
1803
1804     # The informational messages below are now conditional on -v being set -- SOF
1805     if ( ! -f $ofile_target ) {
1806         print STDERR "$Pgm:compile:Output file $ofile_target doesn't exist\n" if $Verbose;
1807         $source_unchanged = 0;
1808     }
1809
1810     ($o_dev,$o_ino,$o_mode,$o_nlink,$o_uid,$o_gid,$o_rdev,$o_size,
1811      $o_atime,$o_mtime,$o_ctime,$o_blksize,$o_blocks) = stat(_); # stat info from -f test
1812
1813     if ( ! -f $hifile_target ) {
1814         print STDERR "$Pgm:compile:Interface file $hifile_target doesn't exist\n" if $Verbose;
1815         $source_unchanged = 0;
1816     }
1817
1818     ($hi_dev,$hi_ino,$hi_mode,$hi_nlink,$hi_uid,$hi_gid,$hi_rdev,$hi_size,
1819      $hi_atime,$hi_mtime,$hi_ctime,$hi_blksize,$hi_blocks) = stat(_); # stat info from -f test
1820
1821     if ($i_mtime > $o_mtime) {
1822         print STDERR "$Pgm:recompile:Input file $ifile newer than $ofile_target\n" if $Verbose;
1823         $source_unchanged = 0;
1824     }
1825
1826     # So if source_unchanged is still "1", we pass on the good news to the compiler
1827     # The -recomp flag can disable this, forcing recompilation
1828     if ($Do_recomp_chkr && $source_unchanged) {
1829         push(@HsC_flags, '-fsource-unchanged');
1830     }
1831
1832     # Run the compiler
1833
1834     &runHsc($ifile_root, $hsc_out, $hsc_hi, $going_interactive);
1835
1836    # See if it bailed out early, saying nothing needed doing.
1837    # We work this out by seeing if it created an output .hi file
1838
1839     if ( ! -f $hsc_hi && $ProduceHi !~ /-nohifile=/ ) {
1840         # Doesn't exist, so we bailed out early.
1841         # Tell the C compiler and assembler not to run
1842         $do_cc = 0; $do_as = 0;
1843
1844         # Update dependency info, touch both object file and
1845         # interface file, so that the following invariant is
1846         # maintained:
1847         #
1848         #   a dependent module's interface file should after recompilation
1849         #   checking be newer than the interface files of its imports.
1850         #
1851         # That is, if module A's interface file changes, then module B
1852         # (which import from A) needs to be checked.
1853         # If A's change does not affect B, which causes the compiler to bail
1854         # out early, we still need to touch the interface file of B. The reason
1855         # for this is that B may export A's interface.
1856         #
1857         &run_something("touch $ofile_target",
1858                        "Touch $ofile_target,  to propagate dependencies") if $HscOut ne '-N=';
1859         &run_something("touch $hifile_target",
1860                        "Touch $hifile_target,  to propagate dependencies") if $ProduceHi =~ /-nohifile=/ ;
1861
1862     } else {
1863
1864      # Didn't bail out early (new .hi file) so we thunder on
1865
1866         # If non-interactive, heave in the consistency info at the end
1867         # NB: pretty hackish (depends on how $output is set)
1868         if ( ! $going_interactive ) {
1869             if ( $HscOut eq '-C=' ) {
1870             $to_do = "echo 'static char ghc_hsc_ID[] = \"\@(#)hsc $ifile\t$HsC_major_version.$HsC_minor_version,$HsC_consist_options\";' >> $hsc_out";
1871
1872             } elsif ( $HscOut eq '-S=' ) {
1873                 local($consist) = "hsc.$ifile.$HsC_major_version.$HsC_minor_version.$HsC_consist_options";
1874                 $consist =~ s/,/./g;
1875                 $consist =~ s/\//./g;
1876                 $consist =~ s/-/_/g;
1877                 $consist =~ s/[^A-Za-z0-9_.]/ZZ/g; # ToDo: properly?
1878                 $to_do = "echo '\n\t.text\n$consist:' >> $hsc_out";
1879             }
1880             &run_something($to_do, 'Pin on Haskell consistency info');
1881         }
1882
1883
1884         # Interface-handling is important enough to live off by itself
1885         if ( $ProduceHi !~ /-nohifile=/ ) { # If we've produced one, process it.
1886            require('ghc-iface.prl') || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-iface.prl!\n");
1887            &postprocessHiFile($hsc_hi, $hifile_target, $going_interactive);
1888         }
1889         # if we're going to split up object files,
1890         # we inject split markers into the .hc file now
1891         if ( $HscOut eq '-C=' && $SplitObjFiles ) {
1892             &inject_split_markers ( $hsc_out );
1893         }
1894
1895         # save a copy of the .hc file, even if we are carrying on...
1896         if ($HscOut eq '-C=' && $do_cc && $Keep_hc_file_too) {
1897             &saveIntermediate($ifile_root , "hc" , $hsc_out);
1898         }
1899
1900     }
1901 }
1902 \end{code}
1903
1904
1905 \begin{code}
1906 sub runHsc {
1907     local($ifile_root, $hsc_out, $hsc_hi, $going_interactive) = @_;
1908
1909     # prepend comma to HsP flags (so hsc can tell them apart...)
1910     foreach $a ( @HsP_flags ) { $a = ",$a" unless $a =~ /^,/; }
1911
1912     &makeHiMap() unless $HiMapDone;
1913     #print STDERR "HiIncludes: $HiIncludeString\n";
1914     push(@HsC_flags, "-himap=$HiIncludeString");
1915
1916     # here, we may produce .hc/.s and/or .hi files
1917     local($output) = '';
1918     @Files_to_tidy = ();
1919
1920     if ( $going_interactive ) {
1921         # don't need .hi unless going to show it on stdout:
1922         $ProduceHi = '-nohifile=' if ! $HiOnStdout;
1923         $do_cc = 0; $do_as = 0; $Do_lnkr = 0; # and we won't go any further...
1924     }
1925
1926     # set up for producing output/.hi; note that flag twiddling
1927     # may mean that nothing will actually be produced:
1928     $output = "$ProduceHi$hsc_hi $HscOut$hsc_out";
1929     @Files_to_tidy = ( $hsc_hi, $hsc_out );
1930
1931     # if we're compiling foo.hs, we want the GC stats to end up in foo.stat
1932     if ( $CollectingGCstats ) {
1933         push(@HsC_rts_flags, "-S$ifile_root.stat");
1934         push(@Files_to_tidy, "$ifile_root.stat");
1935     }
1936
1937     if ( $CollectGhcTimings ) { # assume $RTS_style eq 'ghc'
1938         # emit nofibbish time/bytes-alloc stats to stderr;
1939         # see later .stat file post-processing
1940         push(@HsC_rts_flags, "-s$Tmp_prefix.stat");
1941         push(@Files_to_tidy, "$Tmp_prefix.stat");
1942     }
1943
1944     local($dump) = '';
1945     if ($Specific_dump_file ne '') {
1946         $dump = "2>> $Specific_dump_file";
1947         $Using_dump_file = 1;
1948     }
1949
1950     local($to_do);
1951     $to_do = "$HsC @HsP_flags ,$hscpp_hsc $dump @HsC_flags $CoreLint $StgLint $Verbose $output +RTS @HsC_rts_flags";
1952     &run_something($to_do, 'Haskell compiler');
1953
1954     # finish business w/ nofibbish time/bytes-alloc stats
1955     &process_ghc_timings() if $CollectGhcTimings;
1956 }
1957 \end{code}
1958
1959 Use \tr{@Import_dir} and \tr{@SysImport_dir} to make a tmp file
1960 of (module-name, pathname) pairs, one per line, separated by a space.
1961 \begin{code}
1962 $HiMapDone = 0;
1963 $HiIncludeString = ();          # dir1:dir2:dir3, to pass to GHC
1964
1965 sub makeHiMap {
1966
1967     # collect in %HiMap; write later; also used elsewhere in driver
1968
1969     local($mod, $path, $d, $e);
1970
1971     # reset the global variables:
1972     $HiMapDone = 0;
1973     $HiIncludeString = ();              # dir1:dir2:dir3, to pass to GHC
1974
1975     foreach $d ( @Import_dir ) {
1976         if ($HiIncludeString) {
1977            $HiIncludeString = "$HiIncludeString:${d}%.${HiSuffix}";
1978         } else {
1979            $HiIncludeString = "$d%.${HiSuffix}";
1980         }
1981
1982     }
1983
1984     foreach $d ( @SysImport_dir ) {
1985         if ($HiIncludeString) {
1986             $HiIncludeString = "$HiIncludeString:${d}%.${HiSuffix_prelude}";
1987         } else {
1988             $HiIncludeString = "${d}%.${HiSuffix_prelude}";
1989         }
1990     }
1991
1992     $HiMapDone = 1;
1993 }
1994
1995 \end{code}
1996
1997 %************************************************************************
1998 %*                                                                      *
1999 \section[Driver-misc-utils]{Miscellaneous utilities}
2000 %*                                                                      *
2001 %************************************************************************
2002
2003 %************************************************************************
2004 %*                                                                      *
2005 \subsection[Driver-odir-ify]{@odir_ify@: Mangle filename if \tr{-odir} set}
2006 %*                                                                      *
2007 %************************************************************************
2008
2009 \begin{code}
2010 sub osuf_ify {
2011     local($ofile,$def_suffix) = @_;
2012
2013     return(($Osuffix eq '') ? "$ofile.$def_suffix" : "$ofile.$Osuffix" );
2014 }
2015
2016 sub odir_ify {
2017     local($orig_file, $def_suffix) = @_;
2018     if ($Specific_output_dir eq '') {   # do nothing
2019         &osuf_ify($orig_file, $def_suffix);
2020     } else {
2021         local ($orig_file_only);
2022         ($orig_file_only = $orig_file) =~ s|.*/||;
2023         &osuf_ify("$Specific_output_dir/$orig_file_only",$def_suffix);
2024     }
2025 }
2026 \end{code}
2027
2028 \begin{code}
2029 sub runGcc {
2030     local($is_hc_file, $hsc_out, $cc_as_o) = @_;
2031
2032     local($includes) = '-I' . join(' -I', @Include_dir);
2033     local($cc);
2034     local($s_output);
2035     local($c_flags) = "@CcBoth_flags";
2036     local($ddebug_flag) = ( $DEBUGging ) ? '-DDEBUG' : '';
2037
2038     # "input" files to use that are not in some weird directory;
2039     # to help C compilers grok .hc files [ToDo: de-hackify]
2040     local($cc_help)   = "ghc$$.c";
2041     local($cc_help_s) = "ghc$$.s";
2042
2043     $cc       = $CcRegd;
2044     $s_output = ($is_hc_file || $TargetPlatform =~ /^(powerpc|rs6000|hppa|i386)/) ? $cc_as_o : $cc_as;
2045     $c_flags .= " @CcRegd_flags";
2046     $c_flags .= ($is_hc_file) ? " @CcRegd_flags_hc"  : " @CcRegd_flags_c";
2047
2048     # C compiler won't like the .hc extension.  So we create
2049     # a tmp .c file which #include's the needful.
2050     open(TMP, "> $cc_help") || &tidy_up_and_die(1,"$Pgm: failed to open `$cc_help' (to write)\n");
2051     if ( $is_hc_file ) {
2052         print TMP <<EOINCL;
2053 #ifdef __STG_GCC_REGS__
2054 # if ! (defined(MAIN_REG_MAP) || defined(MARK_REG_MAP) || defined(SCAN_REG_MAP) || defined(SCAV_REG_MAP) || defined(FLUSH_REG_MAP))
2055 #  define MAIN_REG_MAP
2056 # endif
2057 #endif
2058 #include "stgdefs.h"
2059 EOINCL
2060         # user may have asked for #includes to be injected...
2061         print TMP @CcInjects if $#CcInjects >= 0;
2062     }
2063     # heave in the consistency info
2064     print TMP "static char ghc_cc_ID[] = \"\@(#)cc $ifile\t$Cc_major_version.$Cc_minor_version,$Cc_consist_options\";\n";
2065
2066     # and #include the real source
2067     print TMP "#include \"$hsc_out\"\n";
2068     close(TMP) || &tidy_up_and_die(1,"Failed writing to $cc_help\n");
2069
2070     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 )";
2071     # note: __GLASGOW_HASKELL__ is pointedly *not* #defined at the C level.
2072     if ( $Only_preprocess_C ) { # HACK ALERT!
2073         $to_do =~ s/ -S\b//g;
2074     }
2075     @Files_to_tidy = ( $cc_help, $cc_help_s, $s_output );
2076     $PostprocessCcOutput = 1;   # hack, dear hack...
2077     &run_something($to_do, 'C compiler');
2078     $PostprocessCcOutput = 0;
2079     unlink($cc_help, $cc_help_s);
2080 }
2081 \end{code}
2082
2083 \begin{code}
2084 sub runMangler {
2085     local($is_hc_file, $cc_as_o, $cc_as, $ifile_root) = @_;
2086
2087     if ( $is_hc_file ) {
2088         # dynamically load assembler-fiddling code, which we are about to use:
2089         require('ghc-asm.prl')
2090         || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm.prl!\n");
2091     }
2092
2093     print STDERR `cat $cc_as_o` if $Dump_raw_asm; # to stderr, before mangling
2094
2095     if ($is_hc_file) {
2096         # post-process the assembler [.hc files only]
2097         &mangle_asm($cc_as_o, $cc_as);
2098
2099
2100 #OLD: for sanity:
2101 #OLD:   local($target) = 'oops';
2102 #OLD:   $target = '-alpha'      if $TargetPlatform =~ /^alpha-/;
2103 #OLD:   $target = '-hppa'       if $TargetPlatform =~ /^hppa/;
2104 #OLD:   $target = '-old-asm'    if $TargetPlatform =~ /^i386-/;
2105 #OLD:   $target = '-m68k'       if $TargetPlatform =~ /^m68k-/;
2106 #OLD:   $target = '-mips'       if $TargetPlatform =~ /^mips-/;
2107 #OLD:   $target = ''            if $TargetPlatform =~ /^powerpc-/;
2108 #OLD:   $target = '-solaris'    if $TargetPlatform =~ /^sparc-sun-solaris2/;
2109 #OLD:   $target = '-sparc'      if $TargetPlatform =~ /^sparc-sun-sunos4/;
2110 #OLD:
2111 #OLD:   if ( $target ne '' ) {
2112 #OLD:       require("ghc-asm$target.prl")
2113 #OLD:       || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm$target.prl!\n");
2114 #OLD:       &mangle_asm($cc_as_o, "$cc_as-2"); # the OLD one!
2115 #OLD:       &run_something("$Cmp -s $cc_as-2 $cc_as || $Diff $cc_as-2 $cc_as 1>&2 || exit 0",
2116 #OLD:           "Diff'ing old and new mangled .s files"); # NB: to stderr
2117 #OLD:   }
2118
2119     } elsif ($TargetPlatform =~ /^hppa/) {
2120         # minor mangling of non-threaded files for hp-pa only
2121         require('ghc-asm.prl')
2122         || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-hppa.prl!\n");
2123         &mini_mangle_asm_hppa($cc_as_o, $cc_as);
2124
2125     } elsif ($TargetPlatform =~ /^powerpc|^rs6000/) {
2126         # minor mangling of non-threaded files for powerpcs and rs6000s
2127         require('ghc-asm.prl')
2128         || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-powerpc.prl!\n");
2129         &mini_mangle_asm_powerpc($cc_as_o, $cc_as);
2130     } elsif ($TargetPlatform =~ /^i386/) {
2131         # extremely-minor OFFENSIVE mangling of non-threaded just one file
2132         require('ghc-asm.prl')
2133         || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm.prl!\n");
2134         &mini_mangle_asm_i386($cc_as_o, $cc_as);
2135     }
2136
2137     # save a copy of the .s file, even if we are carrying on...
2138     #if ($do_as && $Keep_s_file_too) {
2139     #    &saveIntermediate($ifile_root , "s" , $cc_as);
2140     #}
2141 }
2142 \end{code}
2143
2144 \begin{code}
2145 sub runAs {
2146     local($as_out, $ifile_root) = @_;
2147
2148     local($asmblr) = ( $As ) ? $As : $CcRegd;
2149
2150     if ( ! $SplitObjFiles ) {
2151         local($to_do)  = "$asmblr -o $as_out -c @As_flags $cc_as";
2152         @Files_to_tidy = ( $as_out );
2153         &run_something($to_do, 'Unix assembler');
2154
2155     } else { # more complicated split-ification...
2156
2157         # must assemble files $Tmp_prefix__[1 .. $NoOfSplitFiles].s
2158
2159         # If -odir is used, great, just pin it in front of the
2160         # generated split file names. If it hasn't been set, we
2161         # snatch it from the ifile_root.
2162         #
2163         #
2164
2165         if ( $Specific_output_dir eq '' ) {
2166             $Specific_output_dir = ${ifile_root};
2167         }
2168
2169         for ($f = 1; $f <= $NoOfSplitFiles; $f++ ) {
2170             local($split_out) = &odir_ify("${ifile_root}__${f}",'o');
2171             local($to_do) = "$asmblr -o $split_out -c @As_flags ${Tmp_prefix}__${f}.s";
2172             @Files_to_tidy = ( $split_out );
2173
2174             &run_something($to_do, 'Unix assembler');
2175         }
2176     }
2177 }
2178 \end{code}
2179
2180 %************************************************************************
2181 %*                                                                      *
2182 \subsection[Driver-run-something]{@run_something@: Run a phase}
2183 %*                                                                      *
2184 %************************************************************************
2185
2186 \begin{code}
2187 sub run_something {
2188     local($str_to_do, $tidy_name) = @_;
2189
2190     print STDERR "\n$tidy_name:\n\t" if $Verbose;
2191     print STDERR "$str_to_do\n" if $Verbose;
2192
2193     if ($Using_dump_file) {
2194         open(DUMP, ">> $Specific_dump_file")
2195             || &tidy_up_and_die(1,"$Pgm: failed to open `$Specific_dump_file'\n");
2196         print DUMP "\nCompilation Dump for: $str_to_do\n\n";
2197         close(DUMP)
2198             || &tidy_up_and_die(1,"$Pgm: failed closing `$Specific_dump_file'\n");
2199     }
2200
2201     local($return_val) = 0;
2202
2203     if ( length($str_to_do) > 4000) {
2204       # 4000 - on the random side, just like the *real* ARG_MAX
2205       # for some shells.
2206
2207       # With some shells, command lines of this length may
2208       # very well cause trouble. To safeguard against this, we squirrel the
2209       # command into a file and exec that.
2210       local ($sh) = $ENV{'REAL_SHELL'};
2211       print STDERR "Backup plan A: saving cmd line in ${Tmp_prefix}.sh and executing that with $sh\n" if $Verbose;
2212       open (TEMP, "> ${Tmp_prefix}.sh") ||
2213                 &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.sh'\n");
2214       print TEMP "$Time $str_to_do\n";
2215       close (TEMP) ||
2216                 &tidy_up_and_die(1,"$Pgm: failed closing `$Tmp_prefix.sh'\n");
2217       system("$sh $Tmp_prefix.sh");
2218       $return_val = $?;
2219
2220       unlink "${Tmp_prefix}.sh";
2221     } else {
2222       system("$Time $str_to_do");
2223       $return_val = $?;
2224     }
2225
2226     if ( $PostprocessCcOutput ) { # hack, continued
2227         open(CCOUT, "< $Tmp_prefix.ccout")
2228             || &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.ccout'\n");
2229         while ( <CCOUT> ) {
2230             next if /attribute directive ignored/;
2231             next if /call-clobbered/;
2232             next if /from .*COptRegs\.lh/;
2233             next if /from .*(stg|rts)defs\.h:/;
2234             next if /from ghc\d+.c:\d+:/;
2235             next if /from .*\.lc/;
2236             next if /from .*SMinternal\.l?h/;
2237             next if /ANSI C does not support \`long long\'/;
2238             next if /warning:.*was declared \`extern\' and later \`static\'/;
2239             next if /warning: assignment discards \`const\' from pointer target type/;
2240             next if /: At top level:$/;
2241             next if /: In function \`.*\':$/;
2242             next if /\`ghc_cc_ID\' defined but not used/;
2243             print STDERR $_;
2244         }
2245         close(CCOUT) || &tidy_up_and_die(1,"$Pgm: failed closing `$Tmp_prefix.ccout'\n");
2246     }
2247
2248     if ($return_val != 0) {
2249         if ($Using_dump_file) {
2250             print STDERR "Compilation Errors dumped in $Specific_dump_file\n";
2251         }
2252
2253         &tidy_up_and_die($return_val, '');
2254     }
2255     $Using_dump_file = 0;
2256 }
2257 \end{code}
2258
2259 %************************************************************************
2260 %*                                                                      *
2261 \subsection[Driver-ghc-timing]{Emit nofibbish GHC timings}
2262 %*                                                                      *
2263 %************************************************************************
2264
2265 NB: nearly the same as in @runstdtest@ script.
2266
2267 \begin{code}
2268 sub process_ghc_timings {
2269     local($StatsFile) = "$Tmp_prefix.stat";
2270     local($SysSpecificTiming) = 'ghc';
2271
2272     open(STATS, $StatsFile) || die "Failed when opening $StatsFile\n";
2273     local($tot_live) = 0; # for calculating avg residency
2274
2275     while (<STATS>) {
2276         $tot_live += $1 if /^\s*\d+\s+\d+\s+\d+\.\d+\%\s+(\d+)\s+\d+\.\d+\%/;
2277
2278         $BytesAlloc = $1 if /^\s*([0-9,]+) bytes allocated in the heap/;
2279
2280         if ( /^\s*([0-9,]+) bytes maximum residency .* (\d+) sample/ ) {
2281             $MaxResidency = $1; $ResidencySamples = $2;
2282         }
2283
2284         $GCs = $1 if /^\s*([0-9,]+) garbage collections? performed/;
2285
2286         if ( /^\s*INIT\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2287             $InitTime = $1; $InitElapsed = $2;
2288         } elsif ( /^\s*MUT\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2289             $MutTime = $1; $MutElapsed = $2;
2290         } elsif ( /^\s*GC\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2291             $GcTime = $1; $GcElapsed = $2;
2292         }
2293     }
2294     close(STATS) || die "Failed when closing $StatsFile\n";
2295     if ( defined($ResidencySamples) && $ResidencySamples > 0 ) {
2296         $AvgResidency = int ($tot_live / $ResidencySamples) ;
2297     }
2298
2299     # warn about what we didn't find
2300     print STDERR "Warning: BytesAlloc not found in stats file\n" unless defined($BytesAlloc);
2301     print STDERR "Warning: GCs not found in stats file\n" unless defined($GCs);
2302     print STDERR "Warning: InitTime not found in stats file\n" unless defined($InitTime);
2303     print STDERR "Warning: InitElapsed not found in stats file\n" unless defined($InitElapsed);
2304     print STDERR "Warning: MutTime not found in stats file\n" unless defined($MutTime);
2305     print STDERR "Warning: MutElapsed not found in stats file\n" unless defined($MutElapsed);
2306     print STDERR "Warning: GcTime inot found in stats file\n" unless defined($GcTime);
2307     print STDERR "Warning: GcElapsed not found in stats file\n" unless defined($GcElapsed);
2308
2309     # things we didn't necessarily expect to find
2310     $MaxResidency     = 0 unless defined($MaxResidency);
2311     $AvgResidency     = 0 unless defined($AvgResidency);
2312     $ResidencySamples = 0 unless defined($ResidencySamples);
2313
2314     # a bit of tidying
2315     $BytesAlloc =~ s/,//g;
2316     $MaxResidency =~ s/,//g;
2317     $GCs =~ s/,//g;
2318     $InitTime =~ s/,//g;
2319     $InitElapsed =~ s/,//g;
2320     $MutTime =~ s/,//g;
2321     $MutElapsed =~ s/,//g;
2322     $GcTime =~ s/,//g;
2323     $GcElapsed =~ s/,//g;
2324
2325     # print out what we found
2326     print STDERR "<<$SysSpecificTiming: ",
2327         "$BytesAlloc bytes, $GCs GCs, $AvgResidency/$MaxResidency avg/max bytes residency ($ResidencySamples samples), $InitTime INIT ($InitElapsed elapsed), $MutTime MUT ($MutElapsed elapsed), $GcTime GC ($GcElapsed elapsed)",
2328         " :$SysSpecificTiming>>\n";
2329
2330     # OK, party over
2331     unlink $StatsFile;
2332 }
2333 \end{code}
2334
2335 %************************************************************************
2336 %*                                                                      *
2337 \subsection[Driver-dying]{@tidy_up@ and @tidy_up_and_die@: Dying gracefully}
2338 %*                                                                      *
2339 %************************************************************************
2340
2341 \begin{code}
2342 sub tidy_up {
2343     local($to_do) = "\n$Rm $Tmp_prefix*";
2344     if ( $Tmp_prefix !~ /^\s*$/ ) {
2345         print STDERR "$to_do\n" if $Verbose;
2346         system($to_do);
2347     }
2348 }
2349
2350 sub tidy_up_and_die {
2351     local($return_val, $msg) = @_;
2352
2353     # delete any files to tidy
2354     print STDERR "deleting... @Files_to_tidy\n" if $Verbose && $#Files_to_tidy >= 0;
2355     unlink @Files_to_tidy if $#Files_to_tidy >= 0;
2356
2357     &tidy_up();
2358     print STDERR $msg;
2359     exit (($return_val == 0) ? 0 : 1);
2360 }
2361 \end{code}
2362
2363 %************************************************************************
2364 %*                                                                      *
2365 \subsection[Driver-arg-with-arg]{@grab_arg_arg@: Do an argument with an argument}
2366 %*                                                                      *
2367 %************************************************************************
2368
2369 Some command-line arguments take an argument, e.g.,
2370 \tr{-Rmax-heapsize} expects a number to follow.  This can either be
2371 given a part of the same argument (\tr{-Rmax-heapsize8M}) or as the
2372 next argument (\tr{-Rmax-heapsize 8M}).  We allow both cases.
2373
2374 Note: no error-checking; \tr{-Rmax-heapsize -Rgc-stats} will silently
2375 gobble the second argument (and probably set the heapsize to something
2376 nonsensical).
2377 \begin{code}
2378 sub grab_arg_arg {
2379     local(*Args, $option, $rest_of_arg) = @_;
2380
2381     if ($rest_of_arg) {
2382         return($rest_of_arg);
2383     } elsif ($#Args >= 0) {
2384         local($temp) = $Args[0]; shift(@Args);
2385         return($temp);
2386     } else {
2387         print STDERR "$Pgm: no argument following $option option\n";
2388         $Status++;
2389     }
2390 }
2391 \end{code}
2392
2393 \begin{code}
2394 sub isntAntiFlag {
2395     local($flag) = @_;
2396     local($f);
2397
2398 #Not in HsC_antiflag ## NO!: and not already in HsC_flags
2399
2400     foreach $f ( @HsC_antiflags ) {
2401         return(0) if $flag eq $f;
2402     }
2403 #    foreach $f ( @HsC_flags ) {
2404 #       return(0) if $flag eq $f;
2405 #    }
2406     return(1);
2407 }
2408
2409 sub squashHscFlag {  # pretty terrible
2410     local($flag) = @_;
2411     local($f);
2412
2413     foreach $f ( @HsC_flags ) {
2414         if ($flag eq $f) { $f = ''; }
2415     }
2416 }
2417
2418 sub add_Hsc_flags {
2419     local(@flags) = @_;
2420     local($f);
2421
2422     foreach $f ( @flags ) {
2423         push( @HsC_flags, $f ) if &isntAntiFlag($f);
2424     }
2425 }
2426 \end{code}
2427
2428 Source files may have {-# OPTIONS ... #-} pragmas at the top, containing
2429 command line options we want to append to collection of commands specified
2430 directly. @check_for_source_options@ looks at the top of a de-lit'ified Haskell
2431 file for any such pragmas:
2432
2433 \begin{code}
2434 sub check_for_source_options {
2435     local($file,$ifile) = @_;
2436     local($comment_start,$comment_end);
2437
2438     if ($ifile =~ /\.hc$/ ||
2439         $ifile =~ /_hc$/  ||
2440         $ifile =~ /\.s$/  ||
2441         $ifile =~ /_s$/ ) {  # `Real' C intermediate
2442        $comment_start = "/\\*";
2443        $comment_end   = "\\*/";
2444     } else { # Assume it is a file containing Haskell source
2445        $comment_start = "{-#";
2446        $comment_end   = "#-}";
2447     }
2448
2449     open(FILE,$file) || return(1); # No big loss
2450
2451     while (<FILE>) {
2452         if ( /^${comment_start} OPTIONS (.*)${comment_end}$/ ) {
2453            # add the options found at the back of the command line.
2454            local(@entries) = split(/\s+/,$1);
2455            print STDERR "Found OPTIONS " . join(' ',@entries) . " in $file\n" if $Verbose;
2456            push(@File_options, @entries);
2457         }
2458         elsif ( /^$/ ) { # ignore empty lines
2459            ;
2460         }
2461         elsif ( /^#line.+$/ ) { # ignore comment lines
2462            ;
2463         }
2464         else { # stop looking, something non-empty / not
2465                # ${comment_start} OPTIONS .. ${comment_end} encountered.
2466             close(FILE);return(0);
2467         }
2468     }
2469     close(FILE);
2470     return(0);
2471 }
2472 \end{code}
2473
2474
2475 We split the initial argv up into three arrays:
2476
2477   - @Cmd_opts
2478   - @Link_file
2479   - @Input_file
2480
2481 the reason for doing so is to be able to deal
2482 with {-# OPTIONS #-} pragma in source files properly.
2483
2484 \begin{code}
2485 sub splitCmdLine {
2486     local(@args) = @_;
2487
2488 arg: while($_ = $args[0]) {
2489     shift(@args);
2490     # sigh, we have to deal with these -option arg specially here.
2491     /^-(tmpdir|odir|o|isuf|osuf|hisuf|hisuf-prelude|odump|syslib)$/ &&
2492        do { push(@Cmd_opts, $_); push(@Cmd_opts,$args[0]); shift(@args); next arg; };
2493     /^-./  && do { push(@Cmd_opts, $_); next arg; };
2494
2495     if (/\.[oa]$/) {
2496         push(@Link_file, $_);
2497     } else {
2498         push(@Input_file, $_);
2499     }
2500
2501     # input files must exist:
2502     if (! -f $_) {
2503         print STDERR "$Pgm: input file doesn't exist: $_\n";
2504         $Status++;
2505     }
2506   }
2507 }
2508
2509 \end{code}
2510
2511 When saving an intermediate file (.hc or .s) away, we
2512 have to prefix any OPTIONS found in the original source file.
2513
2514 \begin{code}
2515 sub saveIntermediate {
2516   local ($final,$suffix,$tmp)= @_ ;
2517   local ($to_do);
2518
2519   # $final  -- root of where to park ${final}.${suffix}
2520   # $tmp    -- temporary file where hsc put the intermediate file.
2521
2522   # Delete the old file
2523   $to_do = "$Rm ${final}.${suffix}"; &run_something($to_do, "Removing old .${suffix} file");
2524
2525   if ( $#File_options >= 0 ) { # OPTIONS found in Haskell source unit
2526     # Add OPTION comment to the top of the generated .${suffix} file
2527     open(TEMP, "> ${final}.${suffix}") || &tidy_up_and_die(1,"Can't open ${final}.${suffix}\n");
2528     print TEMP "/* OPTIONS " . join(' ',@File_options) . " */\n";
2529     close(TEMP);
2530     print STDERR "Prepending OPTIONS: " . join(' ',@File_options) . " to ${final}.${suffix}\n" if $Verbose;
2531   }
2532   $to_do = "$Cat $tmp  >> ${final}.${suffix}";
2533   &run_something($to_do, "Saving copy of .${suffix} file");
2534
2535 }
2536
2537 \end{code}
2538
2539
2540 Command-line processor
2541
2542 \begin{code}
2543 sub processArgs {
2544     local(@Args) = @_;
2545
2546 # can't use getopt(s); what we want is too complicated
2547
2548 arg: while($_ = $Args[0]) {
2549     shift(@Args);
2550
2551     #---------- help -------------------------------------------------------
2552     if (/^-\?$/ || /^--?help$/) { print $LongUsage; exit $Status; }
2553
2554     #-----------version ----------------------------------------------------
2555     /^--version$/   && do { print STDERR "${PROJECTNAME}, version ${PROJECTVERSION}, patchlevel ${PROJECTPATCHLEVEL}\n"; exit $Status; };
2556
2557     #---------- verbosity and such -----------------------------------------
2558     /^-v$/          && do { $Verbose = '-v'; $Time = 'time'; next arg; };
2559
2560     #---------- what phases are to be run ----------------------------------
2561     /^-recomp/      && do { $Do_recomp_chkr = 1; next arg; };
2562
2563     /^-cpp$/        && do { $Cpp_flag_set = 1; next arg; };
2564     # change the global default:
2565     # we won't run cat; we'll run the real thing
2566
2567     /^-C$/          && do { $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0; $HscOut = '-C=';
2568                             next arg; };
2569     # stop after generating C
2570
2571     /^-noC$/        && do { $HscOut = '-N='; $ProduceHi = '-nohifile=';
2572                             $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0;
2573                             next arg; };
2574     # leave out actual C generation (debugging) [also turns off interface gen]
2575
2576     /^-hi$/         && do { $HiOnStdout = 1; $ProduceHi = '-hifile='; next arg; };
2577     # _do_ generate an interface; usually used as: -noC -hi
2578
2579     /^-nohi$/       && do { $ProduceHi = '-nohifile='; next arg; };
2580     # don't generate an interface (even if generating C)
2581
2582     /^-hi-diffs$/             && do { $HiDiff_flag = 'normal'; next arg; };
2583     /^-hi-diffs-with-usages$/ && do { $HiDiff_flag = 'usages'; next arg; };
2584     /^-no-hi-diffs$/          && do { $HiDiff_flag = '';       next arg; };
2585     # show/disable diffs if the interface file changes
2586
2587     /^-E$/          && do { push(@CcBoth_flags, '-E');
2588                             $Only_preprocess_C = 1;
2589                             $Do_as = 0; $Do_lnkr = 0; next arg; };
2590     # stop after preprocessing C
2591     /^-M$/          && do { $Only_generate_deps = 1; $Do_as = 0; $Do_lnkr = 0; next arg; };
2592     # only generate dependency information.
2593     /^-S$/          && do { $Do_as = 0; $Do_lnkr = 0; next arg; };
2594     # stop after generating assembler
2595
2596     /^-c$/          && do { $Do_lnkr = 0; next arg; };
2597     # stop after generating .o files
2598
2599     /^-link-chk$/    && do { $LinkChk = 1; next arg; };
2600     /^-no-link-chk$/ && do { $LinkChk = 0; next arg; };
2601     # don't do consistency-checking after a link
2602
2603     /^-tmpdir$/ && do { $Tmp_prefix = &grab_arg_arg(*Args,'-tmpdir', '');
2604                         $Tmp_prefix = "$Tmp_prefix/ghc$$";
2605                         $ENV{'TMPDIR'} = $Tmp_prefix; # for those who use it...
2606                         next arg; };
2607     # use an alternate directory for temp files
2608
2609     #---------- redirect output --------------------------------------------
2610
2611     # -o <file>; applies to the last phase, whatever it is
2612     # "-o -" sends it to stdout
2613     # if <file> has a directory component, that dir must already exist
2614
2615     /^-odir$/       && do { $Specific_output_dir = &grab_arg_arg(*Args,'-odir', '');
2616                             #
2617                             # Hack, of the worst sort: don't do validation of
2618                             # odir argument if you're using -M (dependency generation).
2619                             #
2620                             if ( ! $Only_generate_deps && ! -d $Specific_output_dir) {
2621                                 print STDERR "$Pgm: -odir: no such directory: $Specific_output_dir\n";
2622                                 $Status++;
2623                             }
2624                             next arg; };
2625
2626     /^-o$/          && do { $Specific_output_file = &grab_arg_arg(*Args,'-o', '');
2627                             if ($Specific_output_file ne '-'
2628                              && $Specific_output_file =~ /(.*)\/[^\/]*$/) {
2629                                 local($dir_part) = $1;
2630                                 if (! -d $dir_part) {
2631                                     print STDERR "$Pgm: no such directory: $dir_part\n";
2632                                     $Status++;
2633                                 }
2634                             }
2635                             next arg; };
2636
2637     # NB: -isuf not documented yet (because it doesn't work yet)
2638     /^-isuf$/       && do { $Isuffix  = &grab_arg_arg(*Args,'-isuf', '');
2639                             if ($Isuffix =~ /\./ ) {
2640                                 print STDERR "$Pgm: -isuf suffix shouldn't contain a .\n";
2641                                 $Status++;
2642                             }
2643                             next arg; };
2644
2645     /^-osuf$/       && do { $Osuffix  = &grab_arg_arg(*Args,'-osuf', '');
2646                             if ($Osuffix =~ /\./ ) {
2647                                 print STDERR "$Pgm: -osuf suffix shouldn't contain a .\n";
2648                                 $Status++;
2649                             }
2650                             next arg; };
2651
2652     # -ohi <file>; send the interface to <file>; "-ohi -" to send to stdout
2653     /^-ohi$/        && do { $Specific_hi_file = &grab_arg_arg(*Args,'-ohi', '');
2654                             if ($Specific_hi_file ne '-'
2655                              && $Specific_hi_file =~ /(.*)\/[^\/]*$/) {
2656                                 local($dir_part) = $1;
2657                                 if (! -d $dir_part) {
2658                                     print STDERR "$Pgm: no such directory: $dir_part\n";
2659                                     $Status++;
2660                                 }
2661                             }
2662                             next arg; };
2663
2664     # The suffix to use when looking for interface files
2665     /^-hisuf$/      && do { $HiSuffix = &grab_arg_arg(*Args,'-hisuf', '');
2666                             if ($HiSuffix =~ /\./ ) {
2667                                 print STDERR "$Pgm: -hisuf suffix shouldn't contain a .\n";
2668                                 $Status++;
2669                             }
2670                             next arg; };
2671     # ToDo: remove, not a `normal' user thing to do (should be automatic)
2672     /^-hisuf-prelude$/      && do { $HiSuffix_prelude = &grab_arg_arg(*Args,'-hisuf-prelude', '');
2673                             if ($HiSuffix =~ /\./ ) {
2674                                 print STDERR "$Pgm: -hisuf-prelude suffix shouldn't contain a .\n";
2675                                 $Status++;
2676                             }
2677                             next arg; };
2678     /^-odump$/      && do { $Specific_dump_file = &grab_arg_arg(*Args,'-odump', '');
2679                             if ($Specific_dump_file =~ /(.*)\/[^\/]*$/) {
2680                                 local($dir_part) = $1;
2681                                 if (! -d $dir_part) {
2682                                     print STDERR "$Pgm: no such directory: $dir_part\n";
2683                                     $Status++;
2684                                 }
2685                             }
2686                             next arg; };
2687
2688     #-------------- scc & Profiling Stuff ----------------------------------
2689
2690     /^-prof$/ && do { $PROFing = 'p'; next arg; }; # profiling -- details later!
2691
2692     /^-auto/ && do {
2693                 # generate auto SCCs on top level bindings
2694                 # -auto-all = all top level bindings
2695                 # -auto     = only top level exported bindings
2696                 $PROFauto = ( /-all/ )
2697                             ? '-fauto-sccs-on-all-toplevs'
2698                             : '-fauto-sccs-on-exported-toplevs';
2699                 next arg; };
2700
2701     /^-caf-all/ && do { # generate individual CAF SCC annotations
2702                 $PROFcaf = '-fauto-sccs-on-individual-cafs';
2703                 next arg; };
2704
2705     /^-ignore-scc$/ && do {
2706                 # forces ignore of scc annotations even if profiling
2707                 $PROFignore_scc = '-W';
2708                 next arg; };
2709
2710     /^-G(.*)$/  && do { push(@HsC_flags, "-G=$1");   # set group for cost centres
2711                         next arg; };
2712
2713     /^-unprof-scc-auto/ && do {
2714                 # generate auto SCCs on top level bindings when not profiling.
2715                 # Used to measure optimisation effects of presence of sccs.
2716                 $UNPROFscc_auto = ( /-all/ )
2717                             ? '-fauto-sccs-on-all-toplevs'
2718                             : '-fauto-sccs-on-exported-toplevs';
2719                 next arg; };
2720
2721     #--------- ticky/concurrent/parallel -----------------------------------
2722     # we sort out the details a bit later on
2723
2724     /^-concurrent$/ && do { $CONCURing = 'c'; next arg; }; # concurrent Haskell
2725     /^-gransim$/    && do { $GRANing   = 'g'; next arg; }; # GranSim
2726     /^-ticky$/      && do { $TICKYing  = 't'; next arg; }; # ticky-ticky
2727     /^-parallel$/   && do { $PARing    = 'p'; next arg; }; # parallel Haskell
2728
2729     #-------------- "user ways" --------------------------------------------
2730
2731     (/^-user-setup-([a-oA-Z])$/ ) &&
2732            do {
2733                 /^-user-setup-([a-oA-Z])$/  && do { $BuildTag = "_$1"; };
2734
2735                 local($stuff) = $UserSetupOpts{$BuildTag};
2736                 local(@opts)  = split(/\s+/, $stuff);
2737
2738                 # feed relevant ops into the arg-processing loop (if any)
2739                 unshift(@Args, @opts) if $#opts >= 0;
2740
2741                 next arg; };
2742
2743     #---------- set search paths for libraries and things ------------------
2744
2745     # we do -i just like HBC (-i clears the list; -i<colon-separated-items>
2746     # prepends the items to the list); -I is for including C .h files.
2747
2748     /^-i$/          && do { @Import_dir = ();  # import path cleared!
2749                             @SysImport_dir = ();
2750                             print STDERR "WARNING: import paths cleared by `-i'\n";
2751                             next arg; };
2752
2753     /^-i(.*)/       && do { local(@new_items)
2754                               = split( /:/, &grab_arg_arg(*Args,'-i', $1));
2755                             unshift(@Import_dir, @new_items);
2756                             next arg; };
2757
2758     /^-I(.*)/       && do { push(@Include_dir,     &grab_arg_arg(*Args,'-I', $1)); next arg; };
2759     /^-L(.*)/       && do { push(@UserLibrary_dir, &grab_arg_arg(*Args,'-L', $1)); next arg; };
2760     /^-l(.*)/       && do { push(@UserLibrary,'-l'.&grab_arg_arg(*Args,'-l', $1)); next arg; };
2761
2762     /^-syslib(.*)/  && do { local($syslib) = &grab_arg_arg(*Args,'-syslib',$1);
2763                             print STDERR "$Pgm: no such system library (-syslib): $syslib\n",
2764                               $Status++ unless $syslib =~ /^(hbc|ghc|posix|contrib)$/;
2765
2766                             unshift(@SysImport_dir,
2767                                 ${INSTALLING}
2768                                 ? "$InstSysLibDir/$syslib/imports"
2769                                 : "$TopPwd/hslibs/$syslib/src");
2770
2771                             if ( ${INSTALLING} ) {
2772                                 push(@SysLibrary_dir,
2773                                         ("$InstSysLibDir"));
2774                             } else {
2775                                 push(@SysLibrary_dir,
2776                                         ("$TopPwd/hslibs/$syslib"
2777                                         ,"$TopPwd/hslibs/$syslib/cbits"));
2778                             }
2779
2780                             push(@SysLibrary, "-lHS$syslib");
2781                             push(@SysLibrary, "-lHS${syslib}_cbits")
2782                               unless $syslib eq 'contrib'; #HACK! it has no cbits
2783
2784                             next arg; };
2785
2786     #=======================================================================
2787     # various flags that we can harmlessly send to one program or another
2788     # (we will later "reclaim" some of the compiler ones now sent to gcc)
2789     #=======================================================================
2790
2791     #---------- this driver itself (ghc) -----------------------------------
2792     # these change what executable is run for each phase:
2793     /^-pgmL(.*)$/   && do { $Unlit      = $1; next arg; };
2794     /^-pgmP(.*)$/   && do { $HsCpp      = $1; next arg; };
2795     /^-pgmC(.*)$/   && do { $HsC        = $1; next arg; };
2796     /^-pgmcO?(.*)$/ && do { $CcRegd     = $1; next arg; }; # the O? for back compat
2797     /^-pgma(.*)$/   && do { $As         = $1; next arg; };
2798     /^-pgml(.*)$/   && do { $Lnkr       = $1; next arg; };
2799     /^-pgmdep(.*)$/ && do { $MkDependHS = $1; next arg; };
2800
2801     #---------- the get-anything-through opts (all pgms) -------------------
2802     # these allow arbitrary option-strings to go to any phase:
2803     /^-optL(.*)$/   && do { push(@Unlit_flags,      $1); next arg; };
2804     /^-optP(.*)$/   && do { push(@HsCpp_flags,      $1); next arg; };
2805     /^-optCrts(.*)$/&& do { push(@HsC_rts_flags,    $1); next arg; };
2806     /^-optC(.*)$/   && do { push(@HsC_flags,        $1); next arg; };
2807     /^-optcpp(.*)$/ && do { push(@Cpp_define,       $1); next arg; };
2808     /^-optc(.*)$/   && do { push(@CcBoth_flags,     $1); next arg; };
2809     /^-opta(.*)$/   && do { push(@As_flags,         $1); next arg; };
2810     /^-optl(.*)$/   && do { push(@Ld_flags,         $1); next arg; };
2811     /^-optdep(.*)$/ && do { push(@MkDependHS_flags, $1); next arg; };
2812
2813     #---------- Haskell C pre-processor (hscpp) ----------------------------
2814     /^-D(.*)/       && do { push(@HsCpp_flags, "'-D".&grab_arg_arg(*Args,'-D',$1)."'"); next arg; };
2815     /^-U(.*)/       && do { push(@HsCpp_flags, "'-U".&grab_arg_arg(*Args,'-U',$1)."'"); next arg; };
2816
2817     /^-genSPECS/   && do { $Cpp_flag_set = 1;
2818                            $genSPECS_flag = $_;
2819                             next arg; };
2820
2821     #---------- post-Haskell "assembler"------------------------------------
2822     /^-ddump-raw-asm$/            && do { $Dump_raw_asm        = 1; next arg; };
2823     /^-ddump-asm-splitting-info$/ && do { $Dump_asm_splitting_info = 1; next arg; };
2824
2825     #---------- Haskell compiler (hsc) -------------------------------------
2826
2827     /^-keep-hc-files?-too$/     && do { $Keep_hc_file_too = 1; next arg; };
2828     /^-keep-s-files?-too$/      && do { $Keep_s_file_too = 1;  next arg; };
2829
2830     /^-fhaskell-1\.3$/          && do { next arg; }; # a no-op right now
2831
2832     /^-fignore-interface-pragmas$/ && do { push(@HsC_flags, $_); next arg; };
2833
2834     /^-fno-implicit-prelude$/      && do { $NoImplicitPrelude= 1; push(@HsC_flags, $_); next arg; };
2835      # don't do stack checking using page fault `trick'.
2836      # (esoteric).
2837     /^-fstack-check$/              && do { $StkChkByPageFaultOK = 0; next arg; };
2838      #
2839      # have the compiler proper generate concurrent code,
2840      # really only used when you want to configure your own
2841      # special user compilation way. (Use -concurrent when
2842      # compiling `Concurrent Haskell' programs).
2843      #
2844      # (ditto for -fgransim, fscc-profiling and -fticky-ticky)
2845      #
2846     /^-fconcurrent$/      && do { push(@HsC_flags,$_); next arg; };
2847     /^-fscc-profiling$/   && do { push(@HsC_flags,$_); next arg; };
2848     /^-fticky-ticky$/     && do { push(@HsC_flags,$_); next arg; };
2849     /^-fgransim$/         && do { push(@HsC_flags,$_); next arg; };
2850
2851     /^-user-prelude-force/      && do { # ignore if not -user-prelude
2852                                         next arg; };
2853
2854     /^-split-objs/      && do {
2855                         if ( $TargetPlatform !~ /^(alpha|hppa1\.1|i386|m68k|mips|powerpc|rs6000|sparc)-/ ) {
2856                             $SplitObjFiles = 0;
2857                             print STDERR "WARNING: don't know how to split objects on this platform: $TargetPlatform\n`-split-objs' option ignored\n";
2858                         } else {
2859                             $SplitObjFiles = 1;
2860                             $HscOut = '-C=';
2861
2862                             push(@HsC_flags, "-fglobalise-toplev-names");
2863                             push(@CcBoth_flags, '-DUSE_SPLIT_MARKERS');
2864
2865                             require('ghc-split.prl')
2866                              || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-split.prl!\n");
2867                         }
2868                         next arg; };
2869
2870     /^-fglasgow-exts$/
2871                 && do { push(@HsC_flags, $_);
2872                         push(@HsP_flags, '-N');
2873
2874 #                       push(@HsC_flags, '-fshow-import-specs');
2875
2876                         next arg; };
2877
2878     /^-fspeciali[sz]e-unboxed$/
2879                 && do { $Oopt_DoSpecialise      = '-fspecialise';
2880                         $Oopt_SpecialiseUnboxed = '-fspecialise-unboxed';
2881                         next arg; };
2882     /^-fspeciali[sz]e$/
2883                 && do { $Oopt_DoSpecialise = '-fspecialise'; next arg; };
2884     /^-fno-speciali[sz]e$/
2885                 && do { $Oopt_DoSpecialise = ''; next arg; };
2886
2887
2888 # Now the foldr/build options, which are *on* by default (for -O).
2889
2890     /^-ffoldr-build$/
2891                     && do { $Oopt_FoldrBuild = 1;
2892                             $Oopt_FB_Support = '-fdo-arity-expand';
2893                             #print "Yes F/B\n";
2894                             next arg; };
2895
2896     /^-fno-foldr-build$/
2897                     && do { $Oopt_FoldrBuild = 0;
2898                             $Oopt_FB_Support = '';
2899                             next arg; };
2900
2901     /^-fno-foldr-build-rule$/
2902                     && do { $Oopt_FoldrBuild = 0;
2903                             next arg; };
2904
2905     /^-fno-enable-tech$/
2906                     && do { $Oopt_FB_Support = '';
2907                             next arg; };
2908
2909     /^-fno-snapback-to-append$/
2910                     && do { $Oopt_FoldrBuildInline .= ' -fdo-not-fold-back-append ';
2911                             next arg; };
2912
2913     # --------------- Renamer -------------
2914
2915
2916     /^-fno-prune-tydecls$/     && do { push(@HsC_flags, $_); next arg; };
2917     /^-fno-prune-instdecls$/     && do { push(@HsC_flags, $_); next arg; };
2918
2919     # ---------------
2920
2921     /^-fasm-(.*)$/  && do { $HscOut = '-S='; next arg; }; # force using nativeGen
2922     /^-fvia-C$/     && do { $HscOut = '-C='; next arg; }; # force using C compiler
2923
2924     # ---------------
2925
2926     /^(-funfolding-use-threshold)(.*)$/
2927                     && do { $Oopt_UnfoldingUseThreshold = $1 . &grab_arg_arg(*Args,$1, $2);
2928                             next arg; };
2929
2930     /^(-fmax-simplifier-iterations)(.*)$/
2931                     && do { $Oopt_MaxSimplifierIterations = $1 . &grab_arg_arg(*Args,$1, $2);
2932                             next arg; };
2933
2934     /^-fno-pedantic-bottoms$/
2935                     && do { $Oopt_PedanticBottoms = ''; next arg; };
2936
2937     /^-fdo-monad-eta-expansion$/
2938                     && do { $Oopt_MonadEtaExpansion = $_; next arg; };
2939
2940     /^-fno-let-from-(case|app|strict-let)$/ # experimental, really (WDP 95/10)
2941                     && do { push(@HsC_flags, $_); next arg; };
2942
2943     /^(-freturn-in-regs-threshold)(.*)$/
2944                     && do { local($what) = $1;
2945                             local($num)  = &grab_arg_arg(*Args,$what, $2);
2946                             if ($num < 2 || $num > 8) {
2947                                 die "Bad experimental flag: $_\n";
2948                             } else {
2949                                 $HscOut = '-C='; # force using C compiler
2950                                 push(@HsC_flags, "$what$num");
2951                                 push(@CcRegd_flags, "-D__STG_REGS_AVAIL__=$num");
2952                             }
2953                             next arg; };
2954
2955     # --------------- Warnings etc. ------
2956
2957     /^-f(show-import-specs)/
2958                     && do { push(@HsC_flags, $_); next arg; };
2959
2960     # for now, just -fwarn-name-shadowing
2961     /^-fwarn-(.*)$/   && do { push(@HsC_flags, $_); next arg; };
2962     /^-fno-(.*)$/   && do { push(@HsC_antiflags, "-f$1");
2963                             &squashHscFlag("-f$1");
2964                             next arg; };
2965
2966     # --------------- platform specific flags (for gcc mostly) ----------------
2967
2968     /^-mlong-calls$/ && do { # for GCC for HP-PA boxes,
2969                              # for 2.6.x..?, does not apply for 2.7.2
2970                              # any longer.
2971                             unshift(@CcBoth_flags, ( $_ ));
2972                             next arg; };
2973
2974     /^-m(v8|sparclite|cypress|supersparc|cpu=(cypress|supersparc))$/
2975                      && do { # for GCC for SPARCs
2976                             unshift(@CcBoth_flags, ( $_ ));
2977                             next arg; };
2978
2979     /^-monly-([432])-regs/ && do { # for iX86 boxes only; no effect otherwise
2980                             $StolenX86Regs = $1;
2981                             next arg; };
2982
2983     #*************** ... and lots of debugging ones (form: -d* )
2984
2985     # -d(no-)core-lint is done this way so it is turn-off-able.
2986     /^-dcore-lint/       && do { $CoreLint = '-dcore-lint'; next arg; };
2987     /^-dno-core-lint/    && do { $CoreLint = '';            next arg; };
2988     # Ditto for STG lint
2989     /^-dstg-lint/       && do { $StgLint = '-dstg-lint'; next arg; };
2990     /^-dno-stg-lint/    && do { $StgLint = '';           next arg; };
2991
2992     /^-d(dump|ppr)-/         && do { push(@HsC_flags, $_); next arg; };
2993     /^-dverbose-(simpl|stg)/ && do { push(@HsC_flags, $_); next arg; };
2994     /^-dshow-passes/         && do { push(@HsC_flags, $_); next arg; };
2995     /^-dshow-rn-trace/       && do { push(@HsC_flags, $_); next arg; };
2996     /^-dsource-stats/        && do { push(@HsC_flags, $_); next arg; };
2997     /^-dsimplifier-stats/    && do { push(@HsC_flags, $_); next arg; };
2998     /^-dstg-stats/           && do { $Oopt_StgStats = $_; next arg; };
2999
3000     #*************** ... and now all these -R* ones for its runtime system...
3001
3002     /^-Rscale-sizes?(.*)/ && do {
3003         $Scale_sizes_by = &grab_arg_arg(*Args,'-Rscale-sizes', $1);
3004         next arg; };
3005
3006     /^(-H|-Rmax-heapsize)(.*)/ && do {
3007         local($heap_size) = &grab_arg_arg(*Args,$1, $2);
3008         if ($heap_size =~ /(\d+)[Kk]$/) {
3009             $heap_size = $1 * 1000;
3010         } elsif ($heap_size =~ /(\d+)[Mm]$/) {
3011             $heap_size = $1 * 1000 * 1000;
3012         } elsif ($heap_size =~ /(\d+)[Gg]$/) {
3013             $heap_size = $1 * 1000 * 1000 * 1000;
3014         }
3015         if ($heap_size <= 0) {
3016             print STDERR "$Pgm: resetting heap-size to zero!!! $heap_size\n";
3017             $Specific_heap_size = 0;
3018
3019         # if several heap sizes given, take the largest...
3020         } elsif ($heap_size >= $Specific_heap_size) {
3021             $Specific_heap_size = $heap_size;
3022         } else {
3023             print STDERR "$Pgm: ignoring heap-size-setting option ($_)...not the largest seen\n";
3024         }
3025         next arg; };
3026
3027     /^-(K|Rmax-(stk|stack)size)(.*)/ && do {
3028         local($flag) = $1;
3029         local($stk_size) = &grab_arg_arg(*Args,'-Rmax-stksize', $3);
3030         if ($stk_size =~ /(\d+)[Kk]$/) {
3031             $stk_size = $1 * 1000;
3032         } elsif ($stk_size =~ /(\d+)[Mm]$/) {
3033             $stk_size = $1 * 1000 * 1000;
3034         } elsif ($stk_size =~ /(\d+)[Gg]$/) {
3035             $stk_size = $1 * 1000 * 1000 * 1000;
3036         }
3037         if ($stk_size <= 0) {
3038             print STDERR "$Pgm: resetting stack-size to zero!!! $stk_size\n";
3039             $Specific_stk_size = 0;
3040
3041         # if several stack sizes given, take the largest...
3042         } elsif ($stk_size >= $Specific_stk_size) {
3043             $Specific_stk_size = $stk_size;
3044         } else {
3045             print STDERR "$Pgm: ignoring stack-size-setting option ($flag $stk_size)...not the largest seen\n";
3046         }
3047         next arg; };
3048
3049     /^-Rgc-stats$/ && do {  $CollectingGCstats++;
3050                             # the two RTSs do this diff ways; we will try to compensate
3051                             next arg; };
3052
3053     /^-Rghc-timing/ && do { $CollectGhcTimings = 1; next arg; };
3054
3055     #---------- C high-level assembler (gcc) -------------------------------
3056     /^-(Wall|ansi|pedantic)$/ && do { push(@CcBoth_flags, $_); next arg; };
3057
3058     # -dgcc-lint is a useful way of making GCC very fussy.
3059     # From alan@spri.levels.unisa.edu.au (Alan Modra).
3060     /^-dgcc-lint$/ && do { push(@CcBoth_flags, '-Wall -Wpointer-arith -Wbad-function-cast -Wcast-qual -Wstrict-prototypes -Wmissing-prototypes -Wmissing-declarations -Wnested-externs'); next arg; };
3061     # An alternate set, from mark@sgcs.com (Mark W. Snitily)
3062     # -Wall -Wstrict-prototypes -Wmissing-prototypes -Wcast-align -Wshadow
3063
3064     # inject "#include <wurble>" into the compiler's C output!
3065
3066     /^-#include(.*)/    && do {
3067         local($to_include) = &grab_arg_arg(*Args,'-#include', $1);
3068         push(@CcInjects, "#include $to_include\n");
3069         next arg; };
3070
3071     #---------- Linker (gcc, really) ---------------------------------------
3072
3073     /^-static$/         && do { push(@Ld_flags, $_); next arg; };
3074
3075     #---------- mixed cc and linker magic ----------------------------------
3076     # this optimisation stuff is finally sorted out later on...
3077
3078     /^-O2-for-C$/ && do { $MinusO2ForC = 1; next arg; };
3079
3080     /^-O[1-2]?$/ && do {
3081                 local($opt_lev) = ( /^-O2$/ ) ? 2 : 1; # max 'em
3082                 $OptLevel = ( $opt_lev > $OptLevel ) ? $opt_lev : $OptLevel;
3083
3084                 $HscOut = '-C=' if $OptLevel == 2; # force use of C compiler
3085                 next arg; };
3086
3087     /^-Onot$/   && do { $OptLevel = 0; next arg; }; # # set it to <no opt>
3088
3089     /^-Ofile(.*)/ && do {
3090                 $OptLevel = 3;
3091                 local($ofile) = &grab_arg_arg(*Args,'-Ofile', $1);
3092                 @HsC_minusO3_flags = ();
3093
3094                 open(OFILE, "< $ofile") || die "Can't open $ofile!\n";
3095                 while (<OFILE>) {
3096                     chop;
3097                     s/\#.*//;       # death to comments
3098                     s/[ \t]+//g;    # death to whitespace
3099                     next if /^$/;   # ditto, blank lines
3100                     s/([()*{}])/\\$1/g;    # protect shell metacharacters
3101                     if ( /^C:(.*)/ ) {
3102                         push(@CcBoth_flags, $1);
3103                     } else {
3104                         push(@HsC_minusO3_flags, $_);
3105                     }
3106                 }
3107                 close(OFILE);
3108                 next arg; };
3109
3110     /^-debug$/  && do { # all this does is mark a .hc/.o as "debugging"
3111                         # in the consistency info
3112                         $DEBUGging = 'd';
3113                         next arg; };
3114
3115     #---------- linking .a file --------------------------------------------
3116
3117     /^-Main(.*)/ && do {
3118                 # specifies main or mainPrimIO to be linked
3119                 $Ld_main = $1;
3120                 next arg; };
3121
3122     #---------- catch unrecognized flags -----------------------------------
3123
3124     /^-./ && do {
3125         print STDERR "$Pgm: unrecognised option: $_\n";
3126         $Status++;
3127         next arg; };
3128
3129 }
3130
3131 } # end of processArgs
3132
3133 \end{code}