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