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