ghc/driver/ghc.lprl

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