ghc/driver/ghc.lprl

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