ghc/driver/ghc.lprl

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