ghc/driver/ghc.lprl

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