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