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