ghc/driver/ghc.lprl

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1996
   3 %
   4 % *** MSUB does some substitutions here ***
   5 % *** grep for $( ***
   6 %
   7
   8 This is the driver script for the Glasgow Haskell compilation system.
   9 It is written in \tr{perl}.  The first section includes a long
  10 ``usage'' message that describes how the driver is supposed to work.
  11
  12 %************************************************************************
  13 %*                                                                      *
  14 \section[Driver-usage]{Usage message}
  15 %*                                                                      *
  16 %************************************************************************
  17
  18 \begin{code}
  19 ($Pgm = $0) =~ s|.*/||;
  20 $ShortUsage  =  "\nUsage: For basic information, try the `-help' option.\n";
  21 $LongUsage = "\n" . <<EOUSAGE;
  22 Use of the Glorious Haskell Compilation System driver:
  23
  24     $Pgm [command-line-options-and-input-files]
  25
  26 ------------------------------------------------------------------------
  27 This driver ($Pgm) guides each input file through (some of the)
  28 possible phases of a compilation:
  29
  30     - unlit:    extract code from a "literate program"
  31     - hscpp:    run code through the C pre-processor (if -cpp flag given)
  32     - hsc:      run the Haskell compiler proper
  33     - gcc:      run the C compiler (if compiling via C)
  34     - as:       run the assembler
  35     - ld:       run the linker
  36
  37 For each input file, the phase to START with is determined by the
  38 file's suffix:
  39     - .lhs      literate Haskell: unlit
  40     - .hs       illiterate Haskell: hsc
  41     - .hc       C from the Haskell compiler: gcc
  42     - .c        C not from the Haskell compiler: gcc
  43     - .s        assembly language: as
  44     - other     passed directly to the linker: ld
  45
  46 If no files are given on the command line, input is taken from
  47 standard input, and processing is as for an .hs file.  (All output is
  48 to stdout or stderr, however).
  49
  50 The phase at which to STOP processing is determined by a command-line
  51 option:
  52     -C          stop after generating C (.hc output)
  53     -E          stop after generating preprocessed C (.i output)
  54     -S          stop after generating assembler (.s output)
  55     -c          stop after generating object files (.o output)
  56
  57 Other commonly-used options are:
  58
  59     -O          An `optimising' package of compiler flags, for faster code
  60
  61     -prof       Compile for cost-centre profiling
  62                 (add -auto for automagic cost-centres on top-level functions)
  63
  64     -fglasgow-exts  Allow Glasgow extensions (unboxed types, etc.)
  65
  66     -H14m       Increase compiler's heap size
  67
  68 The User's Guide has more information about GHC's *many* options.
  69
  70 Given the above, here are some TYPICAL invocations of $Pgm:
  71
  72     # compile a Haskell module to a .o file, optimising:
  73     % $Pgm -c -O Foo.hs
  74     # compile a Haskell module to C (a .hc file), using a bigger heap:
  75     % $Pgm -C -H16m Foo.hs
  76     # compile Haskell-produced C (.hc) to assembly language:
  77     % $Pgm -S Foo.hc
  78     # link three .o files into an executable called "test":
  79     % $Pgm -o test Foo.o Bar.o Baz.o
  80 ------------------------------------------------------------------------
  81 EOUSAGE
  82 \end{code}
  83
  84 %************************************************************************
  85 %*                                                                      *
  86 \section[Driver-init]{Initialisation}
  87 %*                                                                      *
  88 %************************************************************************
  89
  90 Establish what executables to run for the various phases (all the
  91 \tr{$(FOO)} make-variables are \tr{msub}bed for from the
  92 \tr{Makefile}), what the default options are for those phases, and
  93 other similar boring stuff.
  94 \begin{code}
  95 select(STDERR); $| = 1; select(STDOUT); # no STDERR buffering, please.
  96
  97 $HostPlatform   = '$(HOSTPLATFORM)';
  98 $TargetPlatform = '$(TARGETPLATFORM)';
  99
 100 #------------------------------------------------------------------------
 101 # If you are adjusting paths by hand for a binary GHC distribution,
 102 # de-commenting the line to set GLASGOW_HASKELL_ROOT should do.
 103 # Or you can leave it as is, and set the environment variable externally.
 104 #------------------------------------------------------------------------
 105 # $ENV{'GLASGOW_HASKELL_ROOT'} = '/some/absolute/path/name';
 106
 107 if (! $ENV{'GLASGOW_HASKELL_ROOT'}) { # good -- death to environment variables
 108     $TopPwd         = '$(TOP_PWD)';
 109     $InstLibDirGhc  = '$(INSTLIBDIR_GHC)';
 110     $InstDataDirGhc = '$(INSTDATADIR_GHC)';
 111 } else {
 112     $TopPwd = $ENV{'GLASGOW_HASKELL_ROOT'};
 113
 114     if ('$(INSTLIBDIR_GHC)' =~ /.*(\/lib\/ghc\/\d\.\d\d\/[^-]-[^-]-[^-]\/.*)/) {
 115         $InstLibDirGhc  = $ENV{'GLASGOW_HASKELL_ROOT'} . $1;
 116     } else {
 117         print STDERR "GLASGOW_HASKELL_ROOT environment variable is set;\nBut can't untangle $(INSTLIBDIR_GHC).\n(Installation error)\n";
 118         exit(1);
 119     }
 120
 121     if ('$(INSTDATADIR_GHC)' =~ /.*(\/lib\/ghc\/\d\.\d\d\/.*)/) {
 122         $InstDataDirGhc = $ENV{'GLASGOW_HASKELL_ROOT'} . $2;
 123     } else {
 124         print STDERR "GLASGOW_HASKELL_ROOT environment variable is set;\nBut can't untangle $(INSTDATADIR_GHC).\n(Installation error)\n";
 125         exit(1);
 126     }
 127 }
 128
 129 if ( $(INSTALLING) ) {
 130     $InstSysLibDir  = $InstDataDirGhc;
 131     $InstSysLibDir  =~ s/\/ghc\//\/hslibs\//;
 132 } else {
 133     $InstSysLibDir  = "$TopPwd/hslibs";
 134 }
 135
 136 $Status  = 0; # just used for exit() status
 137 $Verbose = '';
 138
 139 # set up signal handler
 140 sub quit_upon_signal { &tidy_up_and_die(1, ''); }
 141 $SIG{'INT'}  = 'quit_upon_signal';
 142 $SIG{'QUIT'} = 'quit_upon_signal';
 143
 144 # where to get "require"d .prl files at runtime (poor man's dynamic loading)
 145 #   (use LIB, not DATA, because we can't be sure of arch-independence)
 146 @INC = ( ( $(INSTALLING) ) ? $InstLibDirGhc
 147                            : "$TopPwd/$(CURRENT_DIR)" );
 148
 149 if ( $ENV{'TMPDIR'} ) { # where to make tmp file names
 150     $Tmp_prefix = ($ENV{'TMPDIR'} . "/ghc$$");
 151 } else {
 152     $Tmp_prefix ="$(TMPDIR)/ghc$$";
 153     $ENV{'TMPDIR'} = '$(TMPDIR)'; # set the env var as well
 154 }
 155
 156 @Files_to_tidy = (); # files we nuke in the case of abnormal termination
 157
 158 $Unlit = ( $(INSTALLING) ) ? "$InstLibDirGhc/unlit"
 159                              : "$TopPwd/$(CURRENT_DIR)/$(GHC_UNLIT)";
 160 @Unlit_flags    = ();
 161
 162 $Cp   = '$(CP)';
 163 $Rm   = '$(RM)';
 164 $Diff = '$(CONTEXT_DIFF)';
 165 $Cat  = 'cat';
 166 $Cmp  = 'cmp';
 167 $Time = '';
 168
 169 $HsCpp   = # but this is re-set to "cat" (after options) if -cpp not seen
 170            ( $(INSTALLING) ) ? "$InstLibDirGhc/hscpp"
 171                              : "$TopPwd/$(CURRENT_DIR)/$(GHC_HSCPP)";
 172 @HsCpp_flags    = ();
 173 $genSPECS_flag  = '';           # See ../utils/hscpp/hscpp.prl
 174
 175 $HsC     = ( $(INSTALLING) ) ? "$InstLibDirGhc/hsc"
 176                              : "$TopPwd/$(CURRENT_DIR)/$(GHC_HSC)";
 177
 178 $SysMan  = ( $(INSTALLING) ) ? "$InstLibDirGhc/SysMan"
 179                              : "$TopPwd/$(CURRENT_DIR)/$(GHC_SYSMAN)";
 180
 181 # HsC_rts_flags: if we want to talk to the LML runtime system
 182 # NB: we don't use powers-of-2 sizes, because this may do
 183 #   terrible things to cache behavior.
 184 $Specific_heap_size = 6 * 1000 * 1000;
 185 $Specific_stk_size  = 1000 * 1000;
 186 $Scale_sizes_by     = 1.0;
 187 @HsC_rts_flags      = ();
 188
 189 @HsP_flags      = (); # these are the flags destined solely for
 190                       # the flex/yacc parser
 191 @HsC_flags      = ();
 192 @HsC_antiflags  = ();
 193 \end{code}
 194
 195 The optimisations/etc to be done by the compiler are {\em normally}
 196 expressed with a \tr{-O} (or \tr{-O2}) flag, or by its absence.
 197
 198 \begin{code}
 199 $OptLevel      = 0; # no -O == 0; -O == 1; -O2 == 2; -Ofile == 3
 200 $MinusO2ForC   = 0; # set to 1 if -O2 should be given to C compiler
 201 $StolenX86Regs = 4; # **HACK*** of the very worst sort
 202 $CoreLint      = '';
 203 \end{code}
 204
 205 These variables represent parts of the -O/-O2/etc ``templates,''
 206 which are filled in later, using these.
 207 These are the default values, which may be changed by user flags.
 208 \begin{code}
 209 $Oopt_UnfoldingUseThreshold     = '-fsimpl-uf-use-threshold3';
 210 $Oopt_MaxSimplifierIterations   = '-fmax-simplifier-iterations4';
 211 $Oopt_PedanticBottoms           = '-fpedantic-bottoms'; # ON by default
 212 $Oopt_MonadEtaExpansion         = '';
 213 $Oopt_FinalStgProfilingMassage  = '';
 214 $Oopt_StgStats                  = '';
 215 $Oopt_SpecialiseUnboxed         = '';
 216 $Oopt_DoSpecialise              = ''; # ToDo:LATER: '-fspecialise';
 217 $Oopt_FoldrBuild                = 0; # *Off* by default!
 218 $Oopt_FB_Support                = ''; # was '-fdo-arity-expand';
 219 #$Oopt_FoldrBuildWW             = 0; # Off by default
 220 $Oopt_FoldrBuildInline          = ''; # was '-fdo-inline-foldr-build';
 221 \end{code}
 222
 223 Things to do with C compilers/etc:
 224 \begin{code}
 225 $CcRegd         = '$(GHC_OPT_HILEV_ASM)';
 226 @CcBoth_flags   = ('-S');   # flags for *any* C compilation
 227 @CcInjects      = ();
 228
 229 # GCC flags: those for all files, those only for .c files; those only for .hc files
 230 @CcRegd_flags    = ('-ansi', '-D__STG_GCC_REGS__', '-D__STG_TAILJUMPS__');
 231 @CcRegd_flags_c = ();
 232 @CcRegd_flags_hc = ();
 233
 234 $As             = ''; # "assembler" is normally GCC
 235 @As_flags       = ();
 236
 237 $Lnkr           = ''; # "linker" is normally GCC
 238 @Ld_flags       = ();
 239
 240 # 'nm' is used for consistency checking (ToDo: mk-world-ify)
 241 # ToDo: check the OS or something ("alpha" is surely not the crucial question)
 242 $Nm = ($TargetPlatform =~ /^alpha-/) ? 'nm -B' : 'nm';
 243 \end{code}
 244
 245 What options \tr{-user-setup-a} turn into (user-defined ``packages''
 246 of options).  Note that a particular user-setup implies a particular
 247 Prelude ({\em including} its interface file(s)).
 248 \begin{code}
 249 $BuildTag       = ''; # default is sequential build w/ Appel-style GC
 250
 251 %BuildAvail     = ('',      '$(Build_normal)',
 252                    '_p',    '$(Build_p)',
 253                    '_t',    '$(Build_t)',
 254                    '_u',    '$(Build_u)',
 255                    '_mc',   '$(Build_mc)',
 256                    '_mr',   '$(Build_mr)',
 257                    '_mt',   '$(Build_mt)',
 258                    '_mp',   '$(Build_mp)',
 259                    '_mg',   '$(Build_mg)',
 260                    '_2s',   '$(Build_2s)',
 261                    '_1s',   '$(Build_1s)',
 262                    '_du',   '$(Build_du)',
 263                    '_a',    '$(Build_a)',
 264                    '_b',    '$(Build_b)',
 265                    '_c',    '$(Build_c)',
 266                    '_d',    '$(Build_d)',
 267                    '_e',    '$(Build_e)',
 268                    '_f',    '$(Build_f)',
 269                    '_g',    '$(Build_g)',
 270                    '_h',    '$(Build_h)',
 271                    '_i',    '$(Build_i)',
 272                    '_j',    '$(Build_j)',
 273                    '_k',    '$(Build_k)',
 274                    '_l',    '$(Build_l)',
 275                    '_m',    '$(Build_m)',
 276                    '_n',    '$(Build_n)',
 277                    '_o',    '$(Build_o)',
 278                    '_A',    '$(Build_A)',
 279                    '_B',    '$(Build_B)' );
 280
 281 %BuildDescr     = ('',      'normal sequential',
 282                    '_p',    'profiling',
 283                    '_t',    'ticky-ticky profiling',
 284 #OLD:              '_u',    'unregisterized (using portable C only)',
 285                    '_mc',   'concurrent',
 286                    '_mr',   'profiled concurrent',
 287                    '_mt',   'ticky concurrent',
 288                    '_mp',   'parallel',
 289                    '_mg',   'GranSim',
 290                    '_2s',   '2-space GC',
 291                    '_1s',   '1-space GC',
 292                    '_du',   'dual-mode GC',
 293                    '_a',    'user way a',
 294                    '_b',    'user way b',
 295                    '_c',    'user way c',
 296                    '_d',    'user way d',
 297                    '_e',    'user way e',
 298                    '_f',    'user way f',
 299                    '_g',    'user way g',
 300                    '_h',    'user way h',
 301                    '_i',    'user way i',
 302                    '_j',    'user way j',
 303                    '_k',    'user way k',
 304                    '_l',    'user way l',
 305                    '_m',    'user way m',
 306                    '_n',    'user way n',
 307                    '_o',    'user way o',
 308                    '_A',    'user way A',
 309                    '_B',    'user way B' );
 310
 311 # these are options that are "fed back" through the option processing loop
 312 %UserSetupOpts  = ('_a', '$(GHC_BUILD_OPTS_a)',
 313                    '_b', '$(GHC_BUILD_OPTS_b)',
 314                    '_c', '$(GHC_BUILD_OPTS_c)',
 315                    '_d', '$(GHC_BUILD_OPTS_d)',
 316                    '_e', '$(GHC_BUILD_OPTS_e)',
 317                    '_f', '$(GHC_BUILD_OPTS_f)',
 318                    '_g', '$(GHC_BUILD_OPTS_g)',
 319                    '_h', '$(GHC_BUILD_OPTS_h)',
 320                    '_i', '$(GHC_BUILD_OPTS_i)',
 321                    '_j', '$(GHC_BUILD_OPTS_j)',
 322                    '_k', '$(GHC_BUILD_OPTS_k)',
 323                    '_l', '$(GHC_BUILD_OPTS_l)',
 324                    '_m', '$(GHC_BUILD_OPTS_m)',
 325                    '_n', '$(GHC_BUILD_OPTS_n)',
 326                    '_o', '$(GHC_BUILD_OPTS_o)',
 327                    '_A', '$(GHC_BUILD_OPTS_A)',
 328                    '_B', '$(GHC_BUILD_OPTS_B)',
 329
 330                    # the GC ones don't have any "fed back" options
 331                    '_2s', '',
 332                    '_1s', '',
 333                    '_du', '' );
 334
 335 # per-build code fragments which are eval'd
 336 %EvaldSetupOpts = ('',      '', # this one must *not* be set!
 337
 338                             # profiled sequential
 339                    '_p',    'push(@HsC_flags,  \'-fscc-profiling\');
 340                              push(@CcBoth_flags, \'-DPROFILING\');',
 341
 342                             #and maybe ...
 343                             #push(@CcBoth_flags, '-DPROFILING_DETAIL_COUNTS');
 344
 345                             # ticky-ticky sequential
 346                    '_t',    'push(@HsC_flags, \'-fticky-ticky\');
 347                              push(@CcBoth_flags, \'-DTICKY_TICKY\');',
 348
 349 #OLD:                       # unregisterized (ToDo????)
 350 #                  '_u',    '',
 351
 352                             # concurrent
 353                    '_mc',   '$StkChkByPageFaultOK = 0;
 354                              push(@HsC_flags,  \'-fconcurrent\');
 355                              push(@HsCpp_flags,\'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\');
 356                              push(@Cpp_define, \'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\');',
 357
 358                             # profiled concurrent
 359                    '_mr',   '$StkChkByPageFaultOK = 0;
 360                              push(@HsC_flags,  \'-fconcurrent\', \'-fscc-profiling\');
 361                              push(@HsCpp_flags,\'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\');
 362                              push(@Cpp_define, \'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\', \'-DPROFILING\');',
 363
 364                             # ticky-ticky concurrent
 365                    '_mt',   '$StkChkByPageFaultOK = 0;
 366                              push(@HsC_flags,  \'-fconcurrent\', \'-fticky-ticky\');
 367                              push(@HsCpp_flags,\'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\');
 368                              push(@Cpp_define, \'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\', \'-DTICKY_TICKY\');',
 369
 370                             # parallel
 371                    '_mp',   '$StkChkByPageFaultOK = 0;
 372                              push(@HsC_flags,  \'-fconcurrent\');
 373                              push(@HsCpp_flags,\'-D__PARALLEL_HASKELL__\',   \'-DPAR\');
 374                              push(@Cpp_define, \'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\', \'-DPAR\');',
 375
 376                             # GranSim
 377                    '_mg',   '$StkChkByPageFaultOK = 0;
 378                              push(@HsC_flags,  \'-fconcurrent\', \'-fgransim\');
 379                              push(@HsCpp_flags,\'-D__GRANSIM__\',   \'-DGRAN\');
 380                              push(@Cpp_define, \'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\', \'-DGRAN\');',
 381
 382                    '_2s',   'push (@CcBoth_flags, \'-DGC2s\');',
 383                    '_1s',   'push (@CcBoth_flags, \'-DGC1s\');',
 384                    '_du',   'push (@CcBoth_flags, \'-DGCdu\');',
 385
 386                    '_a',    '', # these user-way guys should not be set!
 387                    '_b',    '',
 388                    '_c',    '',
 389                    '_d',    '',
 390                    '_e',    '',
 391                    '_f',    '',
 392                    '_g',    '',
 393                    '_h',    '',
 394                    '_i',    '',
 395                    '_j',    '',
 396                    '_k',    '',
 397                    '_l',    '',
 398                    '_m',    '',
 399                    '_n',    '',
 400                    '_o',    '',
 401                    '_A',    '',
 402                    '_B',    '' );
 403 \end{code}
 404
 405 Import/include directories (\tr{-I} options) are sufficiently weird to
 406 require special handling.
 407 \begin{code}
 408 @Import_dir     = ('.'); #-i things
 409 @Include_dir    = ('.'); #-I things; other default(s) stuck on AFTER option processing
 410
 411 @SysImport_dir  = ( $(INSTALLING) )
 412                     ? ( "$InstDataDirGhc/imports" )
 413                     : ( "$TopPwd/$(CURRENT_DIR)/$(GHC_LIBSRC)/prelude"
 414                       , "$TopPwd/$(CURRENT_DIR)/$(GHC_LIBSRC)/required"
 415                       , "$TopPwd/$(CURRENT_DIR)/$(GHC_LIBSRC)/concurrent" );
 416
 417 $GhcVersionInfo  = int ($(PROJECTVERSION) * 100);
 418 $Haskell1Version = 3; # i.e., Haskell 1.3
 419 @Cpp_define      = ();
 420
 421 @UserLibrary_dir= ();   #-L things;...
 422 @UserLibrary    = ();   #-l things asked for by the user
 423
 424 @SysLibrary_dir = ( ( $(INSTALLING) )   #-syslib things supplied by the system
 425                     ? $InstLibDirGhc
 426                     : ( "$TopPwd/$(CURRENT_DIR)/$(GHC_RUNTIMESRC)"
 427                       , "$TopPwd/$(CURRENT_DIR)/$(GHC_RUNTIMESRC)/gmp"
 428                       , "$TopPwd/$(CURRENT_DIR)/$(GHC_LIBSRC)"
 429                       , "$TopPwd/$(CURRENT_DIR)/$(GHC_LIBSRC)/cbits"
 430                       )
 431                   );
 432 @SysLibrary = (); # will be built up as we go along
 433
 434 $TopClosureFile # defaults to 1.2 one; will be mangled later
 435         = ( $(INSTALLING) ) ? "$InstLibDirGhc/TopClosureXXXX.o"
 436                             : "$TopPwd/$(CURRENT_DIR)/$(GHC_RUNTIMESRC)/main/TopClosureXXXX.o";
 437 \end{code}
 438
 439 We are given a list of files with various presumably-known suffixes
 440 (unknown-suffix files go straight to the linker).  For each file, we
 441 begin by assuming that we'll run every phase over it.  However: (1)
 442 global flags (\tr{-c}, \tr{-S}, etc.) tell us not to run any phase
 443 past a certain point; and (2) the file's suffix tells us what phase to
 444 start with.  Linking is weird and kept track of separately.
 445
 446 Here are the initial defaults applied to all files:
 447 \begin{code}
 448 $Cpp_flag_set = 0;      # (hack)
 449 $Only_preprocess_C = 0; # pretty hackish
 450 $PostprocessCcOutput = 0;
 451
 452 # native code-gen or via C?
 453 $HaveNativeCodeGen = $(GhcWithNativeCodeGen);
 454 $HscOut = '-C='; # '-C=' ==> .hc output; '-S=' ==> .s output; '-N=' ==> neither
 455 $HscOut = '-S='
 456     if $HaveNativeCodeGen && $TargetPlatform =~ /^(alpha|sparc)-/; #ToDo: add |i386 !
 457 $ProduceHi   = '-hifile=';
 458 $HiOnStdout  = 0;
 459 $HiDiff_flag = '';
 460
 461 $CollectingGCstats = 0;
 462 $CollectGhcTimings = 0;
 463 $DEBUGging = '';        # -DDEBUG and all that it entails (um... not really)
 464 $PROFing = '';          # set to p or e if profiling
 465 $PROFgroup = '';        # set to group if an explicit -Ggroup specified
 466 $PROFauto = '';         # set to relevant hsc flag if -auto or -auto-all
 467 $PROFcaf  = '';         # set to relevant hsc flag if -caf-all
 468 $PROFignore_scc = '';   # set to relevant parser flag if explicit sccs ignored
 469 $UNPROFscc_auto = '';   # set to relevant hsc flag if forcing auto sccs without profiling
 470 $TICKYing = '';         # set to t if compiling for ticky-ticky profiling
 471 $PARing = '';           # set to p if compiling for PAR
 472 $CONCURing = '';        # set to c if compiling for CONCURRENT
 473 $GRANing = '';          # set to g if compiling for GRAN
 474 $StkChkByPageFaultOK = 1; # may be set to 0 (false) for some builds
 475 $Specific_output_dir = '';      # set by -odir <dir>
 476 $Specific_output_file = '';     # set by -o <file>; "-" for stdout
 477 $Specific_hi_file = '';         # set by -ohi <file>; "-" for stdout
 478 $Specific_dump_file = '';       # set by -odump <file>; "-" for stdout
 479 $Using_dump_file = 0;
 480 $Isuffix    = '';
 481 $Osuffix    = '';       # default: use the normal suffix for that kind of output
 482 $HiSuffix   = 'hi';
 483 $SysHiSuffix= 'hi';
 484 $Do_recomp_chkr = 0;    # don't use the recompilatio checker unless asked
 485 $Do_cc      = -1;   # a MAGIC indeterminate value; will be set to 1 or 0.
 486 $Do_as      = 1;
 487 $Do_lnkr    = 1;
 488 $Keep_hc_file_too = 0;
 489 $Keep_s_file_too = 0;
 490 $UseGhcInternals = 0; # if 1, may use GHC* modules
 491 $SplitObjFiles = 0;
 492 $NoOfSplitFiles = 0;
 493 $Dump_parser_output = 0;
 494 $Dump_raw_asm = 0;
 495 $Dump_asm_splitting_info = 0;
 496 $NoImplicitPrelude = 0;
 497
 498 # and the list of files
 499 @Input_file = ();
 500
 501 # and files to be linked...
 502 @Link_file  = ();
 503 \end{code}
 504
 505 We inject consistency-checking information into \tr{.hc} files (both
 506 when created by the Haskell compiler and when compiled by the C
 507 compiler), so that we can check that an executable is made from
 508 consistently-built pieces.  (The check is normally done just after
 509 linking.)  The checking is done by introducing/munging
 510 \tr{what(1)}-style strings.  Anyway, here are the relevant global
 511 variables and their defaults:
 512 \begin{code}
 513 $LinkChk = 1;   # set to 0 if the link check should *not* be done
 514
 515 # major & minor version numbers; major numbers must always agree;
 516 # minor disagreements yield a warning.
 517 $HsC_major_version = 30;
 518 $HsC_minor_version = 0;
 519 $Cc_major_version  = 35;
 520 $Cc_minor_version  = 0;
 521
 522 # options: these must always agree
 523 $HsC_consist_options = '';    # we record, in this order:
 524                               #     Build tag; debugging?
 525 $Cc_consist_options  = '';    # we record, in this order:
 526                               #     Build tag; debugging?
 527 \end{code}
 528
 529 %************************************************************************
 530 %*                                                                      *
 531 \section[Driver-parse-argv]{Munge the command-line options}
 532 %*                                                                      *
 533 %************************************************************************
 534
 535 Now slurp through the arguments.
 536 \begin{code}
 537
 538 #---------- user defined prelude ---------------------------------------
 539
 540 if (grep(/^-user-prelude$/, @ARGV)) {
 541
 542     # If ARGV contains -user-prelude we are compiling a piece of
 543     # prelude for the user, probably with additional specialise pragmas
 544
 545     # We strip out the -O -f and -user-prelude flags provided on
 546     # the command line and add the ones used to compile the prelude
 547     # ToDo: get these options from a common definition in mkworld
 548
 549     # We also enable any options forced through with -user-prelude-force
 550
 551     # Hey, Check out this grep statement ;-)  (PS)
 552
 553     @ARGV = grep((!/^-O/ && !/^-f/ && !/^-user-prelude$/) || s/^-user-prelude-force//,
 554                  @ARGV);
 555
 556     unshift(@ARGV,
 557         '-fcompiling-ghc-internals=???', # ToDo!!!!
 558         '-O',
 559         '-fshow-pragma-name-errs',
 560         '-fshow-import-specs',
 561         '-fglasgow-exts',
 562         '-genSPECS',
 563         '-DUSE_FOLDR_BUILD',
 564         '-dcore-lint');
 565
 566     print STDERR "ghc: -user-prelude options:\n", "@ARGV", "\n";
 567 }
 568
 569 # can't use getopt(s); what we want is too complicated
 570 arg: while($_ = $ARGV[0]) {
 571     shift(@ARGV);
 572
 573     #---------- help -------------------------------------------------------
 574     if (/^-\?$/ || /^-help$/) { print $LongUsage; exit $Status; }
 575
 576     #---------- verbosity and such -----------------------------------------
 577     /^-v$/          && do { $Verbose = '-v'; $Time = 'time'; next arg; };
 578
 579     #---------- what phases are to be run ----------------------------------
 580     /^-recomp/      && do { $Do_recomp_chkr = 1; next arg; };
 581
 582     /^-cpp$/        && do { $Cpp_flag_set = 1; next arg; };
 583     # change the global default:
 584     # we won't run cat; we'll run the real thing
 585
 586     /^-C$/          && do { $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0; $HscOut = '-C=';
 587                             next arg; };
 588     # stop after generating C
 589
 590     /^-noC$/        && do { $HscOut = '-N='; $ProduceHi = '-nohifile=';
 591                             $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0;
 592                             next arg; };
 593     # leave out actual C generation (debugging) [also turns off interface gen]
 594
 595     /^-hi$/         && do { $HiOnStdout = 1; $ProduceHi = '-hifile='; next arg; };
 596     # _do_ generate an interface; usually used as: -noC -hi
 597
 598     /^-nohi$/       && do { $ProduceHi = '-nohifile='; next arg; };
 599     # don't generate an interface (even if generating C)
 600
 601     /^-hi-diffs$/ &&             do { $HiDiff_flag = 'normal'; next arg; };
 602     /^-hi-diffs-with-usages$/ && do { $HiDiff_flag = 'usages'; next arg; };
 603     /^-no-hi-diffs$/ &&          do { $HiDiff_flag = '';       next arg; };
 604     # show/disable diffs if the interface file changes
 605
 606     /^-E$/          && do { push(@CcBoth_flags, '-E');
 607                             $Only_preprocess_C = 1;
 608                             $Do_as = 0; $Do_lnkr = 0; next arg; };
 609     # stop after preprocessing C
 610
 611     /^-S$/          && do { $Do_as = 0; $Do_lnkr = 0; next arg; };
 612     # stop after generating assembler
 613
 614     /^-c$/          && do { $Do_lnkr = 0; next arg; };
 615     # stop after generating .o files
 616
 617     /^-link-chk$/    && do { $LinkChk = 1; next arg; };
 618     /^-no-link-chk$/ && do { $LinkChk = 0; next arg; };
 619     # don't do consistency-checking after a link
 620
 621     /^-tmpdir$/ && do { $Tmp_prefix = &grab_arg_arg('-tmpdir', '');
 622                         $Tmp_prefix = "$Tmp_prefix/ghc$$";
 623                         $ENV{'TMPDIR'} = $Tmp_prefix; # for those who use it...
 624                         next arg; };
 625     # use an alternate directory for temp files
 626
 627     #---------- redirect output --------------------------------------------
 628
 629     # -o <file>; applies to the last phase, whatever it is
 630     # "-o -" sends it to stdout
 631     # if <file> has a directory component, that dir must already exist
 632
 633     /^-odir$/       && do { $Specific_output_dir = &grab_arg_arg('-odir', '');
 634                             if (! -d $Specific_output_dir) {
 635                                 print STDERR "$Pgm: -odir: no such directory: $Specific_output_dir\n";
 636                                 $Status++;
 637                             }
 638                             next arg; };
 639
 640     /^-o$/          && do { $Specific_output_file = &grab_arg_arg('-o', '');
 641                             if ($Specific_output_file ne '-'
 642                              && $Specific_output_file =~ /(.*)\/[^\/]*$/) {
 643                                 local($dir_part) = $1;
 644                                 if (! -d $dir_part) {
 645                                     print STDERR "$Pgm: no such directory: $dir_part\n";
 646                                     $Status++;
 647                                 }
 648                             }
 649                             next arg; };
 650
 651     # NB: -isuf not documented yet (because it doesn't work yet)
 652     /^-isuf$/       && do { $Isuffix  = &grab_arg_arg('-isuf', '');
 653                             if ($Isuffix =~ /\./ ) {
 654                                 print STDERR "$Pgm: -isuf suffix shouldn't contain a .\n";
 655                                 $Status++;
 656                             }
 657                             next arg; };
 658
 659     /^-osuf$/       && do { $Osuffix  = &grab_arg_arg('-osuf', '');
 660                             if ($Osuffix =~ /\./ ) {
 661                                 print STDERR "$Pgm: -osuf suffix shouldn't contain a .\n";
 662                                 $Status++;
 663                             }
 664                             next arg; };
 665
 666     # -ohi <file>; send the interface to <file>; "-ohi -" to send to stdout
 667     /^-ohi$/        && do { $Specific_hi_file = &grab_arg_arg('-ohi', '');
 668                             if ($Specific_hi_file ne '-'
 669                              && $Specific_hi_file =~ /(.*)\/[^\/]*$/) {
 670                                 local($dir_part) = $1;
 671                                 if (! -d $dir_part) {
 672                                     print STDERR "$Pgm: no such directory: $dir_part\n";
 673                                     $Status++;
 674                                 }
 675                             }
 676                             next arg; };
 677
 678     /^-hisuf$/      && do { $HiSuffix = &grab_arg_arg('-hisuf', '');
 679                             if ($HiSuffix =~ /\./ ) {
 680                                 print STDERR "$Pgm: -hisuf suffix shouldn't contain a .\n";
 681                                 $Status++;
 682                             }
 683                             next arg; };
 684     /^-hisuf-prelude$/ && do { # as esoteric as they come...
 685                             $SysHiSuffix = &grab_arg_arg('-hisuf-prelude', '');
 686                             if ($SysHiSuffix =~ /\./ ) {
 687                                 print STDERR "$Pgm: -hisuf-prelude suffix shouldn't contain a .\n";
 688                                 $Status++;
 689                             }
 690                             next arg; };
 691
 692     /^-odump$/      && do { $Specific_dump_file = &grab_arg_arg('-odump', '');
 693                             if ($Specific_dump_file =~ /(.*)\/[^\/]*$/) {
 694                                 local($dir_part) = $1;
 695                                 if (! -d $dir_part) {
 696                                     print STDERR "$Pgm: no such directory: $dir_part\n";
 697                                     $Status++;
 698                                 }
 699                             }
 700                             next arg; };
 701
 702     #-------------- scc & Profiling Stuff ----------------------------------
 703
 704     /^-prof$/ && do { $PROFing = 'p'; next arg; }; # profiling -- details later!
 705
 706     /^-auto/ && do {
 707                 # generate auto SCCs on top level bindings
 708                 # -auto-all = all top level bindings
 709                 # -auto     = only top level exported bindings
 710                 $PROFauto = ( /-all/ )
 711                             ? '-fauto-sccs-on-all-toplevs'
 712                             : '-fauto-sccs-on-exported-toplevs';
 713                 next arg; };
 714
 715     /^-caf-all/ && do { # generate individual CAF SCC annotations
 716                 $PROFcaf = '-fauto-sccs-on-individual-cafs';
 717                 next arg; };
 718
 719     /^-ignore-scc$/ && do {
 720                 # forces ignore of scc annotations even if profiling
 721                 $PROFignore_scc = '-W';
 722                 next arg; };
 723
 724     /^-G(.*)$/  && do { push(@HsC_flags, "-G=$1");   # set group for cost centres
 725                         next arg; };
 726
 727     /^-unprof-scc-auto/ && do {
 728                 # generate auto SCCs on top level bindings when not profiling
 729                 # used to measure optimisation effects of presence of sccs
 730                 $UNPROFscc_auto = ( /-all/ )
 731                             ? '-fauto-sccs-on-all-toplevs'
 732                             : '-fauto-sccs-on-exported-toplevs';
 733                 next arg; };
 734
 735     #--------- ticky/concurrent/parallel -----------------------------------
 736     # we sort out the details a bit later on
 737
 738     /^-concurrent$/ && do { $CONCURing = 'c'; next arg; }; # concurrent Haskell
 739     /^-gransim$/    && do { $GRANing   = 'g'; next arg; }; # GranSim
 740     /^-ticky$/      && do { $TICKYing  = 't'; next arg; }; # ticky-ticky
 741     /^-parallel$/   && do { $PARing    = 'p'; next arg; } ; # parallel Haskell
 742
 743     #-------------- "user ways" --------------------------------------------
 744
 745     (/^-user-setup-([a-oA-Z])$/
 746     || /^$(GHC_BUILD_FLAG_a)$/
 747     || /^$(GHC_BUILD_FLAG_b)$/
 748     || /^$(GHC_BUILD_FLAG_c)$/
 749     || /^$(GHC_BUILD_FLAG_d)$/
 750     || /^$(GHC_BUILD_FLAG_e)$/
 751     || /^$(GHC_BUILD_FLAG_f)$/
 752     || /^$(GHC_BUILD_FLAG_g)$/
 753     || /^$(GHC_BUILD_FLAG_h)$/
 754     || /^$(GHC_BUILD_FLAG_i)$/
 755     || /^$(GHC_BUILD_FLAG_j)$/
 756     || /^$(GHC_BUILD_FLAG_k)$/
 757     || /^$(GHC_BUILD_FLAG_l)$/
 758     || /^$(GHC_BUILD_FLAG_m)$/
 759     || /^$(GHC_BUILD_FLAG_n)$/
 760     || /^$(GHC_BUILD_FLAG_o)$/
 761     || /^$(GHC_BUILD_FLAG_A)$/
 762     || /^$(GHC_BUILD_FLAG_B)$/
 763
 764     || /^$(GHC_BUILD_FLAG_2s)$/ # GC ones...
 765     || /^$(GHC_BUILD_FLAG_1s)$/
 766     || /^$(GHC_BUILD_FLAG_du)$/
 767     ) && do {
 768                 /^-user-setup-([a-oA-Z])$/  && do { $BuildTag = "_$1"; };
 769
 770                 /^$(GHC_BUILD_FLAG_a)$/  && do { $BuildTag = '_a';  };
 771                 /^$(GHC_BUILD_FLAG_b)$/  && do { $BuildTag = '_b';  };
 772                 /^$(GHC_BUILD_FLAG_c)$/  && do { $BuildTag = '_c';  };
 773                 /^$(GHC_BUILD_FLAG_d)$/  && do { $BuildTag = '_d';  };
 774                 /^$(GHC_BUILD_FLAG_e)$/  && do { $BuildTag = '_e';  };
 775                 /^$(GHC_BUILD_FLAG_f)$/  && do { $BuildTag = '_f';  };
 776                 /^$(GHC_BUILD_FLAG_g)$/  && do { $BuildTag = '_g';  };
 777                 /^$(GHC_BUILD_FLAG_h)$/  && do { $BuildTag = '_h';  };
 778                 /^$(GHC_BUILD_FLAG_i)$/  && do { $BuildTag = '_i';  };
 779                 /^$(GHC_BUILD_FLAG_j)$/  && do { $BuildTag = '_j';  };
 780                 /^$(GHC_BUILD_FLAG_k)$/  && do { $BuildTag = '_k';  };
 781                 /^$(GHC_BUILD_FLAG_l)$/  && do { $BuildTag = '_l';  };
 782                 /^$(GHC_BUILD_FLAG_m)$/  && do { $BuildTag = '_m';  };
 783                 /^$(GHC_BUILD_FLAG_n)$/  && do { $BuildTag = '_n';  };
 784                 /^$(GHC_BUILD_FLAG_o)$/  && do { $BuildTag = '_o';  };
 785                 /^$(GHC_BUILD_FLAG_A)$/  && do { $BuildTag = '_A';  };
 786                 /^$(GHC_BUILD_FLAG_B)$/  && do { $BuildTag = '_B';  };
 787
 788                 /^$(GHC_BUILD_FLAG_2s)$/ && do { $BuildTag = '_2s'; };
 789                 /^$(GHC_BUILD_FLAG_1s)$/ && do { $BuildTag = '_1s'; };
 790                 /^$(GHC_BUILD_FLAG_du)$/ && do { $BuildTag = '_du'; };
 791
 792                 local($stuff) = $UserSetupOpts{$BuildTag};
 793                 local(@opts)  = split(/\s+/, $stuff);
 794
 795                 # feed relevant ops into the arg-processing loop (if any)
 796                 unshift(@ARGV, @opts) if $#opts >= 0;
 797
 798                 next arg; };
 799
 800     #---------- set search paths for libraries and things ------------------
 801
 802     # we do -i just like HBC (-i clears the list; -i<colon-separated-items>
 803     # prepends the items to the list); -I is for including C .h files.
 804
 805     /^-i$/          && do { @Import_dir = ();  # import path cleared!
 806                             @SysImport_dir = ();
 807                             print STDERR "WARNING: import paths cleared by `-i'\n";
 808                             next arg; };
 809
 810     /^-i(.*)/       && do { local(@new_items)
 811                               = split( /:/, &grab_arg_arg('-i', $1));
 812                             unshift(@Import_dir, @new_items);
 813                             next arg; };
 814
 815     /^-I(.*)/       && do { push(@Include_dir,     &grab_arg_arg('-I', $1)); next arg; };
 816     /^-L(.*)/       && do { push(@UserLibrary_dir, &grab_arg_arg('-L', $1)); next arg; };
 817     /^-l(.*)/       && do { push(@UserLibrary,'-l'.&grab_arg_arg('-l', $1)); next arg; };
 818
 819     /^-syslib(.*)/  && do { local($syslib) = &grab_arg_arg('-syslib',$1);
 820                             print STDERR "$Pgm: no such system library (-syslib): $syslib\n",
 821                               $Status++ unless $syslib =~ /^(hbc|ghc|posix|contrib)$/;
 822
 823                             unshift(@SysImport_dir,
 824                                 $(INSTALLING)
 825                                 ? "$InstSysLibDir/$syslib/imports"
 826                                 : "$TopPwd/hslibs/$syslib/src");
 827
 828                             if ( $(INSTALLING) ) {
 829                                 push(@SysLibrary_dir,
 830                                         ("$InstSysLibDir/$TargetPlatform"));
 831                             } else {
 832                                 push(@SysLibrary_dir,
 833                                         ("$TopPwd/hslibs/$syslib"
 834                                         ,"$TopPwd/hslibs/$syslib/cbits"));
 835                             }
 836
 837                             push(@SysLibrary, "-lHS$syslib");
 838                             push(@SysLibrary, "-lHS${syslib}_cbits")
 839                               unless $syslib eq 'contrib'; #HACK! it has no cbits
 840
 841                             next arg; };
 842
 843     #=======================================================================
 844     # various flags that we can harmlessly send to one program or another
 845     # (we will later "reclaim" some of the compiler ones now sent to gcc)
 846     #=======================================================================
 847
 848     #---------- this driver itself (ghc) -----------------------------------
 849     # these change what executable is run for each phase:
 850     /^-pgmL(.*)$/   && do { $Unlit   = $1; next arg; };
 851     /^-pgmP(.*)$/   && do { $HsCpp   = $1; next arg; };
 852     /^-pgmC(.*)$/   && do { $HsC     = $1; next arg; };
 853     /^-pgmcO?(.*)$/ && do { $CcRegd  = $1; next arg; }; # the O? for back compat
 854     /^-pgma(.*)$/   && do { $As      = $1; next arg; };
 855     /^-pgml(.*)$/   && do { $Lnkr    = $1; next arg; };
 856
 857     #---------- the get-anything-through opts (all pgms) -------------------
 858     # these allow arbitrary option-strings to go to any phase:
 859     /^-optL(.*)$/   && do { push(@Unlit_flags,   $1); next arg; };
 860     /^-optP(.*)$/   && do { push(@HsCpp_flags,   $1); next arg; };
 861     /^-optCrts(.*)$/&& do { push(@HsC_rts_flags, $1); next arg; };
 862     /^-optC(.*)$/   && do { push(@HsC_flags,     $1); next arg; };
 863     /^-optc(.*)$/   && do { push(@CcBoth_flags,  $1); next arg; };
 864     /^-opta(.*)$/   && do { push(@As_flags,      $1); next arg; };
 865     /^-optl(.*)$/   && do { push(@Ld_flags,      $1); next arg; };
 866
 867     #---------- Haskell C pre-processor (hscpp) ----------------------------
 868     /^-D(.*)/       && do { push(@HsCpp_flags, "'-D".&grab_arg_arg('-D',$1)."'"); next arg; };
 869     /^-U(.*)/       && do { push(@HsCpp_flags, "'-U".&grab_arg_arg('-U',$1)."'"); next arg; };
 870
 871     /^-genSPECS/   && do { $Cpp_flag_set = 1;
 872                            $genSPECS_flag = $_;
 873                             next arg; };
 874
 875     #---------- post-Haskell "assembler"------------------------------------
 876     /^-ddump-raw-asm$/            && do { $Dump_raw_asm        = 1; next arg; };
 877     /^-ddump-asm-splitting-info$/ && do { $Dump_asm_splitting_info = 1; next arg; };
 878
 879     #---------- Haskell compiler (hsc) -------------------------------------
 880
 881     /^-keep-hc-files?-too$/     && do { $Keep_hc_file_too = 1; next arg; };
 882     /^-keep-s-files?-too$/      && do { $Keep_s_file_too = 1;  next arg; };
 883
 884     /^-fhaskell-1\.3$/          && do { next arg; }; # a no-op right now
 885
 886     /^-fignore-interface-pragmas$/ && do { push(@HsC_flags, $_); next arg; };
 887
 888     /^-fno-implicit-prelude$/      && do { $NoImplicitPrelude= 1; push(@HsC_flags, $_); next arg; };
 889
 890     # ToDo: rename to -fcompiling-ghc-internals=<module>
 891     # NB: not documented
 892     /^-fcompiling-ghc-internals(.*)/    && do { local($m) = &grab_arg_arg('-fcompiling-ghc-internals',$1);
 893                                         push(@HsC_flags, "-fcompiling-ghc-internals=$m");
 894                                         next arg; };
 895
 896     # NB: not really put to use and not documented
 897     /^-fusing-ghc-internals$/ && do { $UsingGhcInternals = 1; next arg; };
 898
 899     /^-user-prelude-force/      && do { # ignore if not -user-prelude
 900                                         next arg; };
 901
 902     /^-split-objs(.*)/  && do {
 903                         local($sname) = &grab_arg_arg('-split-objs', $1);
 904                         $sname =~ s/ //g; # no spaces
 905
 906                         if ( $TargetPlatform !~ /^(alpha|hppa1\.1|i386|m68k|mips|powerpc|sparc)-/ ) {
 907                             $SplitObjFiles = 0;
 908                             print STDERR "WARNING: don't know how to split objects on this platform: $TargetPlatform\n`-split-objs' option ignored\n";
 909                         } else {
 910                             $SplitObjFiles = 1;
 911                             $HscOut = '-C=';
 912
 913                             push(@HsC_flags, "-fglobalise-toplev-names=$sname");
 914                             push(@CcBoth_flags, '-DUSE_SPLIT_MARKERS');
 915
 916                             require('ghc-split.prl')
 917                              || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-split.prl!\n");
 918                         }
 919                         next arg; };
 920
 921     /^-fglasgow-exts$/
 922                 && do { push(@HsC_flags, $_);
 923                         push(@HsP_flags, '-N');
 924
 925 #                       push(@HsC_flags, '-fshow-import-specs');
 926
 927                         next arg; };
 928
 929     /^-fspeciali[sz]e-unboxed$/
 930                 && do { $Oopt_DoSpecialise      = '-fspecialise';
 931                         $Oopt_SpecialiseUnboxed = '-fspecialise-unboxed';
 932                         next arg; };
 933     /^-fspeciali[sz]e$/
 934                 && do { $Oopt_DoSpecialise = '-fspecialise'; next arg; };
 935     /^-fno-speciali[sz]e$/
 936                 && do { $Oopt_DoSpecialise = ''; next arg; };
 937
 938
 939 # Now the foldr/build options, which are *on* by default (for -O).
 940
 941     /^-ffoldr-build$/
 942                     && do { $Oopt_FoldrBuild = 1;
 943                             $Oopt_FB_Support = '-fdo-arity-expand';
 944                             #print "Yes F/B\n";
 945                             next arg; };
 946
 947     /^-fno-foldr-build$/
 948                     && do { $Oopt_FoldrBuild = 0;
 949                             $Oopt_FB_Support = '';
 950                             next arg; };
 951
 952     /^-fno-foldr-build-rule$/
 953                     && do { $Oopt_FoldrBuild = 0;
 954                             next arg; };
 955
 956     /^-fno-enable-tech$/
 957                     && do { $Oopt_FB_Support = '';
 958                             next arg; };
 959
 960     /^-fno-snapback-to-append$/
 961                     && do { $Oopt_FoldrBuildInline .= ' -fdo-not-fold-back-append ';
 962                             #print "No Foldback of append\n";
 963                             next arg; };
 964
 965     # ---------------
 966
 967     /^-fasm-(.*)$/  && do { $HscOut = '-S='; next arg; }; # force using nativeGen
 968     /^-fvia-C$/     && do { $HscOut = '-C='; next arg; }; # force using C compiler
 969
 970     # ---------------
 971
 972     /^(-fsimpl-uf-use-threshold)(.*)$/
 973                     && do { $Oopt_UnfoldingUseThreshold = $1 . &grab_arg_arg($1, $2);
 974                             next arg; };
 975
 976     /^(-fmax-simplifier-iterations)(.*)$/
 977                     && do { $Oopt_MaxSimplifierIterations = $1 . &grab_arg_arg($1, $2);
 978                             next arg; };
 979
 980     /^-fno-pedantic-bottoms$/
 981                     && do { $Oopt_PedanticBottoms = ''; next arg; };
 982
 983     /^-fdo-monad-eta-expansion$/
 984                     && do { $Oopt_MonadEtaExpansion = $_; next arg; };
 985
 986     /^-fno-let-from-(case|app|strict-let)$/ # experimental, really (WDP 95/10)
 987                     && do { push(@HsC_flags, $_); next arg; };
 988
 989     /^(-freturn-in-regs-threshold)(.*)$/
 990                     && do { local($what) = $1;
 991                             local($num)  = &grab_arg_arg($what, $2);
 992                             if ($num < 2 || $num > 8) {
 993                                 die "Bad experimental flag: $_\n";
 994                             } else {
 995                                 $HscOut = '-C='; # force using C compiler
 996                                 push(@HsC_flags, "$what$num");
 997                                 push(@CcRegd_flags, "-D__STG_REGS_AVAIL__=$num");
 998                             }
 999                             next arg; };
1000
1001     # ---------------
1002
1003     /^-fno-(.*)$/   && do { push(@HsC_antiflags, "-f$1");
1004                             &squashHscFlag("-f$1");
1005                             next arg; };
1006
1007     /^-f(show-import-specs)/
1008                     && do { push(@HsC_flags, $_); next arg; };
1009
1010     # ---------------
1011
1012     /^-mlong-calls$/ && do { # for GCC for HP-PA boxes
1013                             unshift(@CcBoth_flags, ( $_ ));
1014                             next arg; };
1015
1016     /^-m(v8|sparclite|cypress|supersparc|cpu=(cypress|supersparc))$/
1017                      && do { # for GCC for SPARCs
1018                             unshift(@CcBoth_flags, ( $_ ));
1019                             next arg; };
1020
1021     /^-monly-([432])-regs/ && do { # for iX86 boxes only; no effect otherwise
1022                             $StolenX86Regs = $1;
1023                             next arg; };
1024
1025     #*************** ... and lots of debugging ones (form: -d* )
1026
1027     # -d(no-)core-lint is done this way so it is turn-off-able.
1028     /^-dcore-lint/       && do { $CoreLint = '-dcore-lint'; next arg; };
1029     /^-dno-core-lint/    && do { $CoreLint = '';            next arg; };
1030
1031     /^-d(dump|ppr)-/         && do { push(@HsC_flags, $_); next arg; };
1032     /^-dverbose-(simpl|stg)/ && do { push(@HsC_flags, $_); next arg; };
1033     /^-dshow-passes/         && do { push(@HsC_flags, $_); next arg; };
1034     /^-dsource-stats/        && do { push(@HsC_flags, $_); next arg; };
1035     /^-dsimplifier-stats/    && do { push(@HsC_flags, $_); next arg; };
1036     /^-dstg-stats/           && do { $Oopt_StgStats = $_; next arg; };
1037
1038     #*************** ... and now all these -R* ones for its runtime system...
1039
1040     /^-Rscale-sizes?(.*)/ && do {
1041         $Scale_sizes_by = &grab_arg_arg('-Rscale-sizes', $1);
1042         next arg; };
1043
1044     /^(-H|-Rmax-heapsize)(.*)/ && do {
1045         local($heap_size) = &grab_arg_arg($1, $2);
1046         if ($heap_size =~ /(\d+)[Kk]$/) {
1047             $heap_size = $1 * 1000;
1048         } elsif ($heap_size =~ /(\d+)[Mm]$/) {
1049             $heap_size = $1 * 1000 * 1000;
1050         } elsif ($heap_size =~ /(\d+)[Gg]$/) {
1051             $heap_size = $1 * 1000 * 1000 * 1000;
1052         }
1053         if ($heap_size <= 0) {
1054             print STDERR "$Pgm: resetting heap-size to zero!!!\n";
1055             $Specific_heap_size = 0;
1056
1057         # if several heap sizes given, take the largest...
1058         } elsif ($heap_size >= $Specific_heap_size) {
1059             $Specific_heap_size = $heap_size;
1060         } else {
1061             print STDERR "$Pgm: ignoring heap-size-setting option ($_)...not the largest seen\n";
1062         }
1063         next arg; };
1064
1065     /^-(K|Rmax-(stk|stack)size)(.*)/ && do {
1066         local($stk_size) = &grab_arg_arg('-Rmax-stksize', $3);
1067         if ($stk_size =~ /(\d+)[Kk]$/) {
1068             $stk_size = $1 * 1000;
1069         } elsif ($stk_size =~ /(\d+)[Mm]$/) {
1070             $stk_size = $1 * 1000 * 1000;
1071         } elsif ($stk_size =~ /(\d+)[Gg]$/) {
1072             $stk_size = $1 * 1000 * 1000 * 1000;
1073         }
1074         if ($stk_size <= 0) {
1075             print STDERR "$Pgm: resetting stack-size to zero!!!\n";
1076             $Specific_stk_size = 0;
1077
1078         # if several stack sizes given, take the largest...
1079         } elsif ($stk_size >= $Specific_stk_size) {
1080             $Specific_stk_size = $stk_size;
1081         } else {
1082             print STDERR "$Pgm: ignoring stack-size-setting option (-Rmax-stksize $stk_size)...not the largest seen\n";
1083         }
1084         next arg; };
1085
1086     /^-Rgc-stats$/ && do {  $CollectingGCstats++;
1087                             # the two RTSs do this diff ways; we will try to compensate
1088                             next arg; };
1089
1090     /^-Rghc-timing/ && do { $CollectGhcTimings = 1; next arg; };
1091
1092     #---------- C high-level assembler (gcc) -------------------------------
1093     /^-(Wall|ansi|pedantic)$/ && do { push(@CcBoth_flags, $_); next arg; };
1094
1095     # -dgcc-lint is a useful way of making GCC very fussy.
1096     # From alan@spri.levels.unisa.edu.au (Alan Modra).
1097     /^-dgcc-lint$/ && do { push(@CcBoth_flags, '-Wall -Wpointer-arith -Wbad-function-cast -Wcast-qual -Wstrict-prototypes -Wmissing-prototypes -Wmissing-declarations -Wnested-externs'); next arg; };
1098     # An alternate set, from mark@sgcs.com (Mark W. Snitily)
1099     # -Wall -Wstrict-prototypes -Wmissing-prototypes -Wcast-align -Wshadow
1100
1101     # inject "#include <wurble>" into the compiler's C output!
1102
1103     /^-#include(.*)/    && do {
1104         local($to_include) = &grab_arg_arg('-#include', $1);
1105         push(@CcInjects, "#include $to_include\n");
1106         next arg; };
1107
1108     #---------- Linker (gcc, really) ---------------------------------------
1109
1110     /^-static$/         && do { push(@Ld_flags, $_); next arg; };
1111
1112     #---------- mixed cc and linker magic ----------------------------------
1113     # this optimisation stuff is finally sorted out later on...
1114
1115     /^-O2-for-C$/ && do { $MinusO2ForC = 1; next arg; };
1116
1117     /^-O[1-2]?$/ && do {
1118 #               print STDERR "$Pgm: NOTE: this version of GHC doesn't support -O or -O2\n";
1119                 local($opt_lev) = ( /^-O2$/ ) ? 2 : 1; # max 'em
1120                 $OptLevel = ( $opt_lev > $OptLevel ) ? $opt_lev : $OptLevel;
1121
1122                 $HscOut = '-C=' if $OptLevel == 2; # force use of C compiler
1123                 next arg; };
1124
1125     /^-Onot$/   && do { $OptLevel = 0; next arg; }; # # set it to <no opt>
1126
1127     /^-Ofile(.*)/ && do {
1128                 $OptLevel = 3;
1129                 local($ofile) = &grab_arg_arg('-Ofile', $1);
1130                 @HsC_minusO3_flags = ();
1131
1132                 open(OFILE, "< $ofile") || die "Can't open $ofile!\n";
1133                 while (<OFILE>) {
1134                     chop;
1135                     s/\#.*//;       # death to comments
1136                     s/[ \t]+//g;    # death to whitespace
1137                     next if /^$/;   # ditto, blank lines
1138                     s/([()*{}])/\\$1/g;    # protect shell metacharacters
1139                     if ( /^C:(.*)/ ) {
1140                         push(@CcBoth_flags, $1);
1141                     } else {
1142                         push(@HsC_minusO3_flags, $_);
1143                     }
1144                 }
1145                 close(OFILE);
1146                 next arg; };
1147
1148     /^-debug$/  && do { # all this does is mark a .hc/.o as "debugging"
1149                         # in the consistency info
1150                         $DEBUGging = 'd';
1151                         next arg; };
1152
1153     #---------- linking .a file --------------------------------------------
1154
1155     /^-Main(.*)/ && do {
1156                 # specifies main or mainPrimIO to be linked
1157                 $Ld_main = $1;
1158                 next arg; };
1159
1160     #---------- catch unrecognized flags -----------------------------------
1161
1162     /^-./ && do {
1163         print STDERR "$Pgm: unrecognised option: $_\n";
1164         $Status++;
1165         next arg; };
1166
1167     #---------- anything else is considered an input file ------------------
1168     # (well, .o and .a files are immediately queued up as linker fodder..)
1169     if (/\.[oa]$/) {
1170         push(@Link_file, $_);
1171     } else {
1172         push(@Input_file, $_);
1173     }
1174
1175     # input files must exist:
1176     if (! -f $_) {
1177         print STDERR "$Pgm: input file doesn't exist: $_\n";
1178         $Status++;
1179     }
1180 }
1181
1182 # if there are several input files,
1183 # we don't allow \tr{-o <file>} or \tr{-ohi <file>} options...
1184 # (except if linking, of course)
1185
1186 if ($#Input_file > 0 && ( ! $Do_lnkr )) {
1187     if ( ($Specific_output_file ne '' && $Specific_output_file ne '-')
1188       || ($Specific_hi_file ne ''     && $Specific_hi_file ne '-') ) {
1189         print STDERR "$Pgm: You can't use -o or -ohi options if you have multiple input files.\n";
1190         print STDERR "\tPerhaps the -odir option will do what you want.\n";
1191         $Status++;
1192     }
1193 }
1194
1195 # check for various pathological -o and -odir combinations...
1196 if ($Specific_output_dir ne '' && $Specific_output_file ne '') {
1197     if ($Specific_output_file eq '-') {
1198         print STDERR "$Pgm: can't set output directory with -ohi AND have output to stdout\n";
1199         $Status++;
1200     } else { # amalgamate...
1201         $Specific_output_file = "$Specific_output_dir/$Specific_output_file";
1202         # ToDo: check we haven't got a junk name now...
1203         $Specific_output_dir  = ''; # reset
1204     }
1205 }
1206
1207 # PROFILING stuff after argv mangling:
1208 if ( ! $PROFing ) {
1209     # warn about any scc exprs found (in case scc used as identifier)
1210     push(@HsP_flags, '-W');
1211
1212     # add -auto sccs even if not profiling !
1213     push(@HsC_flags, $UNPROFscc_auto) if $UNPROFscc_auto;
1214
1215 } else {
1216     push(@HsC_flags, $PROFauto) if $PROFauto;
1217     push(@HsC_flags, $PROFcaf)  if $PROFcaf;
1218     #push(@HsC_flags, $PROFdict) if $PROFdict;
1219
1220     $Oopt_FinalStgProfilingMassage = '-fmassage-stg-for-profiling';
1221
1222     push(@HsP_flags, (($PROFignore_scc) ? $PROFignore_scc : '-S'));
1223
1224     if ( $SplitObjFiles ) {
1225         # can't split with cost centres -- would need global and externs
1226         print STDERR "$Pgm: WARNING: splitting objects when profiling will *BREAK* if any _scc_s are present!\n";
1227         # (but it's fine if there aren't any _scc_s around...)
1228 #       $SplitObjFiles = 0; # unset
1229         #not an error: for now: $Status++;
1230     }
1231 }
1232
1233 # crash and burn if there were errors
1234 if ( $Status > 0 ) {
1235     print STDERR $ShortUsage;
1236     exit $Status;
1237 }
1238 \end{code}
1239
1240 %************************************************************************
1241 %*                                                                      *
1242 \section[Driver-post-argv-mangling]{Setup after reading options}
1243 %*                                                                      *
1244 %************************************************************************
1245
1246 %************************************************************************
1247 %*                                                                      *
1248 \subsection{Set up for optimisation level (\tr{-O} or whatever)}
1249 %*                                                                      *
1250 %************************************************************************
1251
1252 We come now to the default ``wads of options'' that are turned on by
1253 \tr{-O0} (do min optimisation), \tr{-O} (ordinary optimisation),
1254 \tr{-O2} (aggressive optimisation), or no O-ish flag (compile speed is
1255 more important).
1256
1257 The user can also specify his/her own list of options in a file; in
1258 that case, the work is already done (see stuff about @minusO3@,
1259 earlier...).
1260
1261 GHC allows very precise control of what happens during a compilation.
1262 Core-to-Core and STG-to-STG passes can be run in any order, as many
1263 times as you like.  Individual transformations can be turned on or
1264 disabled.
1265
1266 Sadly, however, there are some interdependencies \& Things You Must
1267 Not Do.  Here is the list.
1268
1269 CORE-TO-CORE PASSES:
1270 \begin{description}
1271 \item[\tr{-fspecialise}:]
1272 The specialiser must have dependency-analysed input; but if you run
1273 the simplifier to do this, you must not let it toss away unused
1274 bindings!  (The typechecker conveys some specialisation info via
1275 ``unused'' bindings...)
1276
1277 \item[\tr{-ffloat-inwards}:]
1278 Floating inwards should be done before strictness analysis, because
1279 the latter will give better results.
1280
1281 \item[\tr{-fstatic-args}:]
1282 The static-arguments-transformation pass {\em must} have the
1283 simplifier run right after it.
1284
1285 \item[\tr{-fcalc-inlinings[12]}:]
1286 Not required, but there may be slight gains by re-simplifying after
1287 this is done.  (You could then \tr{-fcalc-inlinings} again, just for
1288 fun.)
1289
1290 \item[\tr{-ffull-laziness}:]
1291 The (outwards-)let-floater should be the {\em last} Core-to-Core pass
1292 that's run.  (Um, well, howzabout the simplifier just once more...)
1293 \end{description}
1294
1295 STG-TO-STG PASSES:
1296 \begin{description}
1297 \item[\tr{-fupdate-analysis}:]
1298 It really really wants to be the last STG-to-STG pass that is run.
1299 \end{description}
1300
1301 \begin{code}
1302 @HsC_minusNoO_flags
1303   = (   '-fsimplify',
1304           '\(',
1305           $Oopt_FB_Support,
1306 #         '-falways-float-lets-from-lets',      # no idea why this was here (WDP 95/09)
1307           '-ffloat-lets-exposing-whnf',
1308           '-ffloat-primops-ok',
1309           '-fcase-of-case',
1310 #         '-fdo-lambda-eta-expansion',  # too complicated
1311           '-freuse-con',
1312 #         '-flet-to-case',      # no strictness analysis, so...
1313           $Oopt_PedanticBottoms,
1314 #         $Oopt_MonadEtaExpansion,      # no thanks
1315           '-fsimpl-uf-use-threshold0',
1316           '-fessential-unfoldings-only',
1317 #         $Oopt_UnfoldingUseThreshold,  # no thanks
1318           $Oopt_MaxSimplifierIterations,
1319           '\)',
1320         $Oopt_AddAutoSccs,
1321 #       '-ffull-laziness',      # removed 95/04 WDP following Andr\'e's lead
1322
1323         $Oopt_FinalStgProfilingMassage
1324     );
1325
1326 @HsC_minusO_flags # NOTE: used for *both* -O and -O2 (some conditional bits)
1327   = (
1328         # initial simplify: mk specialiser happy: minimum effort please
1329         '-fsimplify',
1330           '\(',
1331           $Oopt_FB_Support,
1332           '-fkeep-spec-pragma-ids',     # required before specialisation
1333           '-fsimpl-uf-use-threshold0',
1334           '-fessential-unfoldings-only',
1335           '-fmax-simplifier-iterations1',
1336           $Oopt_PedanticBottoms,
1337           '\)',
1338
1339         ($Oopt_DoSpecialise) ? (
1340           '-fspecialise-overloaded',
1341           $Oopt_SpecialiseUnboxed,
1342           $Oopt_DoSpecialise,
1343         ) : (),
1344
1345         '-fsimplify',                   # need dependency anal after specialiser ...
1346           '\(',                         # need tossing before calc-inlinings ...
1347           $Oopt_FB_Support,
1348           '-ffloat-lets-exposing-whnf',
1349           '-ffloat-primops-ok',
1350           '-fcase-of-case',
1351           '-fdo-case-elim',
1352           '-fcase-merge',
1353           '-fdo-eta-reduction',
1354           '-fdo-lambda-eta-expansion',
1355           '-freuse-con',
1356           $Oopt_PedanticBottoms,
1357           $Oopt_MonadEtaExpansion,
1358           $Oopt_UnfoldingUseThreshold,
1359           $Oopt_MaxSimplifierIterations,
1360           '\)',
1361
1362 #LATER: '-fcalc-inlinings1', -- pointless for 2.01
1363
1364 #       ($Oopt_FoldrBuildWW) ? (
1365 #               '-ffoldr-build-ww-anal',
1366 #               '-ffoldr-build-worker-wrapper',
1367 #               '-fsimplify',
1368 #                 '\(',
1369 #                 $Oopt_FB_Support,
1370 #                 '-ffloat-lets-exposing-whnf',
1371 #                 '-ffloat-primops-ok',
1372 #                 '-fcase-of-case',
1373 #                 '-fdo-case-elim',
1374 #                 '-fcase-merge',
1375 #                 '-fdo-eta-reduction',
1376 #                 '-fdo-lambda-eta-expansion',
1377 #                 '-freuse-con',
1378 #                 $Oopt_PedanticBottoms,
1379 #                 $Oopt_MonadEtaExpansion,
1380 #                 $Oopt_UnfoldingUseThreshold,
1381 #                 $Oopt_MaxSimplifierIterations,
1382 #                 '\)',
1383 #        ) : (),
1384
1385         # this pass-ordering sequence was agreed by Simon and Andr\'e
1386         # (WDP 94/07, 94/11).
1387         '-ffull-laziness',
1388
1389         ($Oopt_FoldrBuild) ? (
1390           '-ffoldr-build-on',           # desugar list comprehensions for foldr/build
1391
1392           '-fsimplify',
1393             '\(',
1394             '-fignore-inline-pragma',   # **** NB!
1395             '-fdo-foldr-build',         # NB
1396             $Oopt_FB_Support,
1397             '-ffloat-lets-exposing-whnf',
1398             '-ffloat-primops-ok',
1399             '-fcase-of-case',
1400             '-fdo-case-elim',
1401             '-fcase-merge',
1402             '-fdo-eta-reduction',
1403             '-fdo-lambda-eta-expansion',
1404             '-freuse-con',
1405             $Oopt_PedanticBottoms,
1406             $Oopt_MonadEtaExpansion,
1407             $Oopt_UnfoldingUseThreshold,
1408             $Oopt_MaxSimplifierIterations,
1409             '\)',
1410         ) : (),
1411
1412         '-ffloat-inwards',
1413
1414         '-fsimplify',
1415           '\(',
1416           $Oopt_FB_Support,
1417           '-ffloat-lets-exposing-whnf',
1418           '-ffloat-primops-ok',
1419           '-fcase-of-case',
1420           '-fdo-case-elim',
1421           '-fcase-merge',
1422           '-fdo-eta-reduction',
1423           '-fdo-lambda-eta-expansion',
1424           '-freuse-con',
1425           ($Oopt_FoldrBuildInline),
1426                         # you need to inline foldr and build
1427           ($Oopt_FoldrBuild) ? ('-fdo-foldr-build') : (),
1428                         # but do reductions if you see them!
1429           $Oopt_PedanticBottoms,
1430           $Oopt_MonadEtaExpansion,
1431           $Oopt_UnfoldingUseThreshold,
1432           $Oopt_MaxSimplifierIterations,
1433           '\)',
1434
1435         '-fstrictness',
1436
1437         '-fsimplify',
1438           '\(',
1439           $Oopt_FB_Support,
1440           '-ffloat-lets-exposing-whnf',
1441           '-ffloat-primops-ok',
1442           '-fcase-of-case',
1443           '-fdo-case-elim',
1444           '-fcase-merge',
1445           '-fdo-eta-reduction',
1446           '-fdo-lambda-eta-expansion',
1447           '-freuse-con',
1448           '-flet-to-case',              # Aha! Only done after strictness analysis
1449           $Oopt_PedanticBottoms,
1450           $Oopt_MonadEtaExpansion,
1451           $Oopt_UnfoldingUseThreshold,
1452           $Oopt_MaxSimplifierIterations,
1453           '\)',
1454
1455         '-ffloat-inwards',
1456
1457 # Case-liberation for -O2.  This should be after
1458 # strictness analysis and the simplification which follows it.
1459
1460 #       ( ($OptLevel != 2)
1461 #        ? ''
1462 #       : "-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 \\)" ),
1463
1464 # Final clean-up simplification:
1465
1466         '-fsimplify',
1467           '\(',
1468           $Oopt_FB_Support,
1469           '-ffloat-lets-exposing-whnf',
1470           '-ffloat-primops-ok',
1471           '-fcase-of-case',
1472           '-fdo-case-elim',
1473           '-fcase-merge',
1474           '-fdo-eta-reduction',
1475           '-fdo-lambda-eta-expansion',
1476           '-freuse-con',
1477           '-flet-to-case',
1478           '-fignore-inline-pragma',     # **** NB!
1479           $Oopt_FoldrBuildInline,
1480           ($Oopt_FoldrBuild) ? ('-fdo-foldr-build') : (),
1481                         # but still do reductions if you see them!
1482           $Oopt_PedanticBottoms,
1483           $Oopt_MonadEtaExpansion,
1484           $Oopt_UnfoldingUseThreshold,
1485           $Oopt_MaxSimplifierIterations,
1486           '\)',
1487
1488       # '-fstatic-args',
1489
1490 #LATER: '-fcalc-inlinings2', -- pointless for 2.01
1491
1492       # stg2stg passes
1493 #LATER: '-fupdate-analysis',
1494         '-flambda-lift',
1495         $Oopt_FinalStgProfilingMassage,
1496         $Oopt_StgStats,
1497
1498       # flags for stg2stg
1499         '-flet-no-escape',
1500
1501       # SPECIAL FLAGS for -O2
1502         ($OptLevel == 2) ? (
1503           '-fsemi-tagging',
1504         ) : (),
1505     );
1506 \end{code}
1507
1508 Sort out what we're going to do about optimising.  First, the @hsc@
1509 flags and regular @cc@ flags to worry about:
1510 \begin{code}
1511 if ( $OptLevel <= 0 ) {
1512
1513     # for this level, we tell the parser -fignore-interface-pragmas
1514     push(@HsC_flags, '-fignore-interface-pragmas');
1515     # and tell the compiler not to produce them
1516     push(@HsC_flags, '-fomit-interface-pragmas');
1517
1518     &add_Hsc_flags( @HsC_minusNoO_flags );
1519     push(@CcBoth_flags, ($MinusO2ForC) ? '-O2' : '-O'); # not optional!
1520
1521 } elsif ( $OptLevel == 1 || $OptLevel == 2 ) {
1522
1523     &add_Hsc_flags( @HsC_minusO_flags );
1524     push(@CcBoth_flags, ($MinusO2ForC || $OptLevel == 2) ? '-O2' : '-O'); # not optional!
1525     # -O? to GCC is not optional! -O2 probably isn't worth it generally,
1526     # but it *is* useful in compiling the garbage collectors (so said
1527     # Patrick many moons ago...).
1528
1529 } else { # -Ofile, then...
1530
1531     &add_Hsc_flags( @HsC_minusO3_flags );
1532     push(@CcBoth_flags, ($MinusO2ForC) ? '-O2' : '-O'); # possibly to be elaborated...
1533 }
1534 \end{code}
1535
1536 %************************************************************************
1537 %*                                                                      *
1538 \subsection{Check for consistency, etc.}
1539 %*                                                                      *
1540 %************************************************************************
1541
1542 Sort out @$BuildTag@, @$PROFing@, @$CONCURing@, @$PARing@,
1543 @$GRANing@, @$TICKYing@:
1544 \begin{code}
1545 if ( $BuildTag ne '' ) {
1546     local($b) = $BuildDescr{$BuildTag};
1547     if ($CONCURing eq 'c') { print STDERR "$Pgm: Can't mix $b with -concurrent.\n"; exit 1; }
1548     if ($PARing    eq 'p') { print STDERR "$Pgm: Can't mix $b with -parallel.\n"; exit 1; }
1549     if ($GRANing   eq 'g') { print STDERR "$Pgm: Can't mix $b with -gransim.\n"; exit 1; }
1550     if ($TICKYing  eq 't') { print STDERR "$Pgm: Can't mix $b with -ticky.\n"; exit 1; }
1551
1552     # ok to have a user-way profiling build
1553     # eval the profiling opts ... but leave user-way BuildTag
1554     if ($PROFing   eq 'p') { eval($EvaldSetupOpts{'_p'}); }
1555
1556 } elsif ( $PROFing eq 'p' ) {
1557     if ($PARing   eq 'p') { print STDERR "$Pgm: Can't do profiling with -parallel.\n"; exit 1; }
1558     if ($GRANing  eq 'g') { print STDERR "$Pgm: Can't do profiling with -gransim.\n"; exit 1; }
1559     if ($TICKYing eq 't') { print STDERR "$Pgm: Can't do profiling with -ticky.\n"; exit 1; }
1560     $BuildTag = ($CONCURing eq 'c') ? '_mr' : '_p' ; # possibly "profiled concurrent"...
1561
1562 } elsif ( $CONCURing eq 'c' ) {
1563     if ($PARing  eq 'p') { print STDERR "$Pgm: Can't mix -concurrent with -parallel.\n"; exit 1; }
1564     if ($GRANing eq 'g') { print STDERR "$Pgm: Can't mix -concurrent with -gransim.\n"; exit 1; }
1565     $BuildTag = ($TICKYing eq 't')  ? '_mt' : '_mc' ; # possibly "ticky concurrent"...
1566     # "profiled concurrent" already acct'd for...
1567
1568 } elsif ( $PARing eq 'p' ) {
1569     if ($GRANing  eq 'g') { print STDERR "$Pgm: Can't mix -parallel with -gransim.\n"; exit 1; }
1570     if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix -parallel with -ticky.\n"; exit 1; }
1571     $BuildTag = '_mp';
1572
1573     if ( $Do_lnkr && ( ! $ENV{'PVM_ROOT'} || ! $ENV{'PVM_ARCH'} )) {
1574         print STDERR "$Pgm: both your PVM_ROOT and PVM_ARCH environment variables must be set for linking under -parallel.\n";
1575         exit(1);
1576     }
1577
1578 } elsif ( $GRANing eq 'g' ) {
1579     if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix -gransim with -ticky.\n"; exit 1; }
1580     $BuildTag = '_mg';
1581
1582 } elsif ( $TICKYing eq 't' ) {
1583     $BuildTag = '_t';
1584 }
1585 \end{code}
1586
1587 \begin{code}
1588 if ( $BuildTag ne '' ) { # something other than normal sequential...
1589
1590     push(@HsP_flags, "-syshisuffix=$BuildTag.hi"); # use appropriate Prelude .hi files
1591
1592     $HscOut = '-C='; # must go via C
1593
1594     eval($EvaldSetupOpts{$BuildTag});
1595 }
1596 \end{code}
1597
1598 Decide what the consistency-checking options are in force for this run:
1599 \begin{code}
1600 $HsC_consist_options = "${BuildTag},${DEBUGging}";
1601 $Cc_consist_options  = "${BuildTag},${DEBUGging}";
1602 \end{code}
1603
1604 %************************************************************************
1605 %*                                                                      *
1606 \subsection{Add on machine-specific C-compiler flags}
1607 %*                                                                      *
1608 %************************************************************************
1609
1610 Shove on magical machine-specific options.  We use \tr{unshift} to
1611 stick them on the {\em front} of the arrays, so that ``later''
1612 user-specified flags can clobber them (e.g., \tr{-U__STG_REV_TBLS__}).
1613
1614 Note: a few ``always apply'' flags were set at the very beginning.
1615
1616 \begin{code}
1617 if ($TargetPlatform =~ /^alpha-/) {
1618     # we know how to *mangle* asm for alpha
1619     unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1620     unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK;
1621     unshift(@CcBoth_flags,  ('-static'));
1622
1623 } elsif ($TargetPlatform =~ /^hppa/) {
1624     # we know how to *mangle* asm for hppa
1625     unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1626     unshift(@CcBoth_flags,  ('-static'));
1627     # We don't put in '-mlong-calls', because it's only
1628     # needed for very big modules (sigh), and we don't want
1629     # to hobble ourselves further on all the other modules
1630     # (most of them).
1631     unshift(@CcBoth_flags,  ('-D_HPUX_SOURCE'));
1632         # ___HPUX_SOURCE, not _HPUX_SOURCE, is #defined if -ansi!
1633         # (very nice, but too bad the HP /usr/include files don't agree.)
1634
1635 } elsif ($TargetPlatform =~ /^i386-/) {
1636     # we know how to *mangle* asm for X86
1637     unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1638     unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK;
1639
1640     # -fno-defer-pop : basically the same game as for m68k
1641     #
1642     # -fomit-frame-pointer : *must* ; because we're stealing
1643     #   the fp (%ebp) for our register maps.  *All* register
1644     #   maps (in MachRegs.lh) must steal it.
1645
1646     unshift(@CcRegd_flags_hc, '-fno-defer-pop');
1647     unshift(@CcRegd_flags,    '-fomit-frame-pointer');
1648     unshift(@CcRegd_flags,    "-DSTOLEN_X86_REGS=$StolenX86Regs");
1649
1650 } elsif ($TargetPlatform =~ /^m68k-/) {
1651     # we know how to *mangle* asm for m68k
1652     unshift (@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1653     unshift (@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK;
1654
1655     # -fno-defer-pop : for the .hc files, we want all the pushing/
1656     #     popping of args to routines to be explicit; if we let things
1657     #     be deferred 'til after an STGJUMP, imminent death is certain!
1658     #
1659     # -fomit-frame-pointer : *don't*
1660     #     It's better to have a6 completely tied up being a frame pointer
1661     #     rather than let GCC pick random things to do with it.
1662     #     (If we want to steal a6, then we would try to do things
1663     #     as on iX86, where we *do* steal the frame pointer [%ebp].)
1664
1665     unshift(@CcRegd_flags_hc, '-fno-defer-pop');
1666     unshift(@CcRegd_flags,    '-fno-omit-frame-pointer');
1667         # maybe gives reg alloc a better time
1668         # also: -fno-defer-pop is not sufficiently well-behaved without it
1669
1670 } elsif ($TargetPlatform =~ /^mips-/) {
1671     # we (hope to) know how to *mangle* asm for MIPSen
1672     unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1673     unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK;
1674     unshift(@CcBoth_flags,  ('-static'));
1675
1676 } elsif ($TargetPlatform =~ /^powerpc-/) {
1677     # we know how to *mangle* asm for PowerPC
1678     unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1679     unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK;
1680     unshift(@CcBoth_flags,  ('-static')); # always easier to start with
1681     unshift(@CcRegd_flags, ('-finhibit-size-directive')); # avoids traceback tables
1682
1683 } elsif ($TargetPlatform =~ /^sparc-/) {
1684     # we know how to *mangle* asm for SPARC
1685     unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1686     unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK;
1687
1688 }
1689 \end{code}
1690
1691 Same unshifting magic, but for special linker flags.
1692
1693 Should really be whether or not we prepend underscores to global symbols,
1694 not an architecture test.  (JSM)
1695
1696 \begin{code}
1697 $Under = (   $TargetPlatform =~ /^alpha-/
1698           || $TargetPlatform =~ /^hppa/
1699           || $TargetPlatform =~ /^mips-sgi-irix/
1700           || $TargetPlatform =~ /^powerpc-/
1701           || $TargetPlatform =~ /-solaris/
1702           || $TargetPlatform =~ /-linux$/
1703          )
1704          ? '' : '_';
1705
1706 unshift(@Ld_flags,
1707       (($Ld_main) ? (
1708         '-u', "${Under}Main_" . $Ld_main . '_closure',
1709        ) : (),
1710        '-u', "${Under}GHCbase_unsafePerformPrimIO_fast1",
1711        '-u', "${Under}Prelude_Z91Z93_closure", # i.e., []
1712        '-u', "${Under}Prelude_IZh_static_info",
1713        '-u', "${Under}Prelude_False_inregs_info",
1714        '-u', "${Under}Prelude_True_inregs_info",
1715        '-u', "${Under}Prelude_CZh_static_info",
1716        '-u', "${Under}DEBUG_REGS"))
1717        ; # just for fun, now...
1718 \end{code}
1719
1720 %************************************************************************
1721 %*                                                                      *
1722 \subsection{Set up include paths and system-library enslurpment}
1723 %*                                                                      *
1724 %************************************************************************
1725
1726 Now that we know what garbage-collector, etc., are required, we can
1727 finalise our list of libraries to slurp through, and generally Get
1728 Ready for Business.
1729
1730 \begin{code}
1731 # default includes must be added AFTER option processing
1732 if ( ! $(INSTALLING) ) {
1733     push (@Include_dir, "$TopPwd/$(CURRENT_DIR)/$(GHC_INCLUDESRC)");
1734 } else {
1735     push (@Include_dir, "$InstLibDirGhc/includes");
1736     push (@Include_dir, "$InstDataDirGhc/includes");
1737 }
1738 \end{code}
1739
1740 \begin{code}
1741 push(@SysLibrary, ( '-lHS', '-lHS_cbits' )); # basic I/O and prelude stuff
1742
1743 local($f);
1744 foreach $f (@SysLibrary) {
1745     next if $f =~ /_cbits/;
1746     $f .= $BuildTag if $f =~ /^-lHS/;
1747 }
1748
1749 # fiddle the TopClosure file name...
1750 $TopClosureFile =~ s/XXXX//;
1751
1752 # Push library HSrts, plus boring clib bit
1753 push(@SysLibrary, "-lHSrts${BuildTag}");
1754 push(@SysLibrary, '-lHSclib');
1755
1756 # Push the pvm libraries
1757 if ($BuildTag eq '_mp') {
1758     $pvmlib = "$ENV{'PVM_ROOT'}/lib/$ENV{'PVM_ARCH'}";
1759     push(@SysLibrary, "-L$pvmlib", '-lpvm3', '-lgpvm3');
1760     if ( $ENV{'PVM_ARCH'} eq 'SUNMP' ) {
1761         push(@SysLibrary, '-lthread', '-lsocket', '-lnsl');
1762     } elsif ( $ENV{'PVM_ARCH'} eq 'SUN4SOL2' ) {
1763         push(@SysLibrary, '-lsocket', '-lnsl');
1764     }
1765 }
1766
1767 # Push the GNU multi-precision arith lib; and the math library
1768 push(@SysLibrary, '-lgmp');
1769 push(@SysLibrary, '-lm');
1770 \end{code}
1771
1772 %************************************************************************
1773 %*                                                                      *
1774 \subsection{Check that this system was built to do what we are asking}
1775 %*                                                                      *
1776 %************************************************************************
1777
1778 Before continuing we check that the appropriate build is available.
1779
1780 \begin{code}
1781 die "$Pgm: no BuildAvail?? $BuildTag\n" if ! $BuildAvail{$BuildTag}; # sanity
1782
1783 if ( $BuildAvail{$BuildTag} =~ /^NO$/ ) {
1784     print STDERR "$Pgm: a `", $BuildDescr{$BuildTag},
1785         "' \"build\" is not available with your GHC setup.\n";
1786     print STDERR "(It was not configured for it at your site.)\n";
1787     print STDERR $ShortUsage;
1788     exit 1;
1789 }
1790 \end{code}
1791
1792 %************************************************************************
1793 %*                                                                      *
1794 \subsection{Final miscellaneous setup bits before we start going}
1795 %*                                                                      *
1796 %************************************************************************
1797
1798 Record largest specific heapsize, if any.
1799 \begin{code}
1800 $Specific_heap_size = $Specific_heap_size * $Scale_sizes_by;
1801 push(@HsC_rts_flags, '-H'.$Specific_heap_size);
1802 $Specific_stk_size = $Specific_stk_size * $Scale_sizes_by;
1803 push(@HsC_rts_flags, "-K$Specific_stk_size");
1804
1805 # hack to avoid running hscpp
1806 $HsCpp = $Cat if ! $Cpp_flag_set;
1807 \end{code}
1808
1809 If no input or link files seen, then we let 'em feed in stdin; this is
1810 mainly for debugging.
1811 \begin{code}
1812 if ($#Input_file < 0 && $#Link_file < 0) {
1813     @Input_file = ( '-' );
1814
1815     open(INF, "> $Tmp_prefix.hs") || &tidy_up_and_die(1,"Can't open $Tmp_prefix.hs\n");
1816     print STDERR "Enter your Haskell program, end with ^D (on a line of its own):\n";
1817     while (<>) { print INF $_; }
1818     close(INF) || &tidy_up_and_die(1,"Failed writing to $Tmp_prefix.hs\n");
1819 }
1820 \end{code}
1821
1822 Tell the world who we are, if they asked.
1823 \begin{code}
1824 print STDERR "$(PROJECTNAME), version $(PROJECTVERSION) $(PROJECTPATCHLEVEL)\n"
1825     if $Verbose;
1826 \end{code}
1827
1828 %************************************************************************
1829 %*                                                                      *
1830 \section[Driver-main-loop]{Main loop: Process input files, and link if required}
1831 %*                                                                      *
1832 %************************************************************************
1833
1834 Process the input files; don't continue with linking if there are
1835 problems (global variable @$Status@ non-zero).
1836 \begin{code}
1837 foreach $ifile (@Input_file) {
1838     &ProcessInputFile($ifile);
1839 }
1840
1841 if ( $Status > 0 ) { # don't link if there were errors...
1842     print STDERR $ShortUsage;
1843     &tidy_up();
1844     exit $Status;
1845 }
1846 \end{code}
1847
1848 Link if appropriate.
1849 \begin{code}
1850 if ($Do_lnkr) {
1851     local($libdirs) = '';
1852
1853     # glue them together:
1854     push(@UserLibrary_dir, @SysLibrary_dir);
1855
1856     $libdirs = '-L' . join(' -L',@UserLibrary_dir) if $#UserLibrary_dir >= 0;
1857
1858     # for a linker, use an explicitly given one, or the going C compiler ...
1859     local($lnkr) = ( $Lnkr ) ? $Lnkr : $CcRegd;
1860
1861     local($output) = ($Specific_output_file ne '') ? "-o $Specific_output_file" : '';
1862     @Files_to_tidy = ($Specific_output_file ne '') ? $Specific_output_file : 'a.out';
1863
1864     local($to_do) = "$lnkr $Verbose @Ld_flags $output @Link_file $TopClosureFile $libdirs @UserLibrary @SysLibrary";
1865     &run_something($to_do, 'Linker');
1866
1867     # finally, check the consistency info in the binary
1868     local($executable) = $Files_to_tidy[0];
1869     @Files_to_tidy = (); # reset; we don't want to nuke it if it's inconsistent
1870
1871     if ( $LinkChk ) {
1872         # dynamically load consistency-chking code; then do it.
1873         require('ghc-consist.prl')
1874             || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-consist.prl!\n");
1875
1876         &chk_consistency_info ( $executable );
1877     }
1878
1879     # if PVM parallel stuff, we do truly weird things.
1880     # Essentially: (1) move the executable over to where PVM expects
1881     # to find it.  (2) create a script in place of the executable
1882     # which will cause the program to be run, via SysMan.
1883     if ( $PARing eq 'p' ) {
1884         local($pvm_executable) = $executable;
1885         local($pvm_executable_base);
1886
1887         if ( $pvm_executable !~ /^\// ) { # a relative path name: make absolute
1888             local($pwd) = `pwd`;
1889             chop($pwd);
1890             $pwd =~ s/^\/tmp_mnt//;
1891             $pvm_executable = "$pwd/$pvm_executable";
1892         }
1893
1894         $pvm_executable =~ s|/|=|g; # make /s into =s
1895         $pvm_executable_base = $pvm_executable;
1896
1897         $pvm_executable = $ENV{'PVM_ROOT'} . '/bin/' . $ENV{'PVM_ARCH'}
1898                         . "/$pvm_executable";
1899
1900         &run_something("$Rm -f $pvm_executable; $Cp -p $executable $pvm_executable && $Rm -f $executable", 'Moving binary to PVM land');
1901
1902         # OK, now create the magic script for "$executable"
1903         open(EXEC, "> $executable") || &tidy_up_and_die(1,"$Pgm: couldn't open $executable to write!\n");
1904         print EXEC <<EOSCRIPT1;
1905 #!$(PERL)
1906 # =!=!=!=!=!=!=!=!=!=!=!
1907 # This script is automatically generated: DO NOT EDIT!!!
1908 # Generated by Glasgow Haskell, version $(PROJECTVERSION) $(PROJECTPATCHLEVEL)
1909 #
1910 \$pvm_executable      = '$pvm_executable';
1911 \$pvm_executable_base = '$pvm_executable_base';
1912 \$SysMan = '$SysMan';
1913 EOSCRIPT1
1914
1915         print EXEC <<\EOSCRIPT2;
1916 # first, some magical shortcuts to run "commands" on the binary
1917 # (which is hidden)
1918 if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {
1919     local($cmd) = $1;
1920     system("$cmd $pvm_executable");
1921     exit(0); # all done
1922 }
1923
1924 # OK, really run it; process the args first
1925 $ENV{'PE'} = $pvm_executable_base;
1926 $debug = '';
1927 $nprocessors = 2; # the default
1928 @nonPVM_args = ();
1929 $in_RTS_args = 0;
1930
1931 # ToDo: handle --RTS
1932 args: while ($a = shift(@ARGV)) {
1933     if ( $a eq '+RTS' ) {
1934         $in_RTS_args = 1;
1935     } elsif ( $a eq '-RTS' ) {
1936         $in_RTS_args = 0;
1937     }
1938     if ( $a eq '-d' && $in_RTS_args ) {
1939         $debug = '-';
1940     } elsif ( $a =~ /^-N(\d+)/ && $in_RTS_args ) {
1941         $nprocessors = $1;
1942     } else {
1943         push(@nonPVM_args, $a);
1944     }
1945 }
1946
1947 local($return_val) = 0;
1948 system("$SysMan $debug $pvm_executable $nprocessors @nonPVM_args");
1949 $return_val = $?;
1950 system("mv $ENV{'HOME'}/$pvm_executable_base.???.gr .") if -f "$ENV{'HOME'}/$pvm_executable_base.001.gr";
1951 exit($return_val);
1952 EOSCRIPT2
1953         close(EXEC) || die "Failed closing $executable\n";
1954         chmod 0755, $executable;
1955     }
1956 }
1957
1958 # that...  that's all, folks!
1959 &tidy_up();
1960 exit $Status; # will still be 0 if all went well
1961 \end{code}
1962
1963 %************************************************************************
1964 %*                                                                      *
1965 \section[Driver-do-one-file]{How to process a single input file}
1966 %*                                                                      *
1967 %************************************************************************
1968
1969 \begin{code}
1970 sub ProcessInputFile {
1971     local($ifile) = @_;   # input file name
1972     local($ifile_root);   # root of or basename of input file
1973     local($ofile_target); # ultimate output file we hope to produce
1974                           # from input file (need to know for recomp
1975                           # checking purposes)
1976     local($hifile_target);# ditto (but .hi file)
1977 \end{code}
1978
1979 Handle the weirdity of input from stdin.
1980 \begin{code}
1981     if ($ifile ne '-') {
1982         ($ifile_root  = $ifile) =~ s/\.[^\.\/]+$//;
1983         $ofile_target = # may be reset later...
1984                         ($Specific_output_file ne '' && ! $Do_lnkr)
1985                         ? $Specific_output_file
1986                         : &odir_ify($ifile_root, 'o');
1987         $hifile_target= ($Specific_hi_file ne '')
1988                         ? $Specific_hi_file
1989                         : "$ifile_root.$HiSuffix"; # ToDo: odirify?
1990                         # NB: may change if $ifile_root isn't module name (??)
1991     } else {
1992         $ifile = "$Tmp_prefix.hs"; # we know that's where we put the input
1993         $ifile_root   = '_stdin';
1994         $ofile_target = '_stdout'; # gratuitous?
1995         $hifile_target= '_stdout'; # ditto?
1996     }
1997 \end{code}
1998
1999 We need to decide what phases of the compilation system we will run
2000 over this file.  The defaults are the ones established when processing
2001 flags.  (That established what the last phase run for all files is.)
2002
2003 We do the pre-recompilation-checker phases here; the rest later.
2004 \begin{code}
2005 \end{code}
2006
2007 Look at the suffix and decide what initial phases of compilation may
2008 be dropped off for this file.  Also the rather boring business of
2009 which files are coming-in/going-out.
2010
2011 Again, we'll do the post-recompilation-checker parts of this later.
2012 \begin{code}
2013     local($do_lit2pgm)  = ($ifile =~ /\.lhs$/) ? 1 : 0;
2014     local($do_hscpp)    = 1; # but "hscpp" might really be "cat"
2015     local($do_hsc)      = 1;
2016     local($do_cc)       = ( $Do_cc != -1) # i.e., it was set explicitly
2017                           ? $Do_cc
2018                           : ( ($HscOut eq '-C=') ? 1 : 0 );
2019     local($do_as)       = $Do_as;
2020
2021     # names of the files to stuff between phases
2022     # defaults are temporaries
2023     local($in_lit2pgm)    = $ifile;
2024     local($lit2pgm_hscpp) = "$Tmp_prefix.lpp";
2025     local($hscpp_hsc)     = "$Tmp_prefix.cpp";
2026     local($hsc_out)       = ( $HscOut eq '-C=' ) ? "$Tmp_prefix.hc" : "$Tmp_prefix.s" ;
2027     local($hsc_hi)        = "$Tmp_prefix.hi";
2028     local($cc_as_o)       = "${Tmp_prefix}_o.s"; # temporary for raw .s file if opt C
2029     local($cc_as)         = "$Tmp_prefix.s";     # mangled or hsc-produced .s code
2030     local($as_out)        = $ofile_target;
2031
2032     local($is_hc_file) = 1; #Is the C code .hc or .c? Assume .hc for now
2033
2034     if ($ifile =~ /\.lhs$/) {
2035         ; # nothing to change
2036     } elsif ($ifile =~ /\.hs$/) {
2037         $do_lit2pgm = 0;
2038         $lit2pgm_hscpp = $ifile;
2039     } elsif ($ifile =~ /\.hc$/ || $ifile =~ /_hc$/ ) { # || $ifile =~ /\.$Isuffix$/o) # ToDo: better
2040         $do_lit2pgm = 0; $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
2041         $hsc_out = $ifile;
2042     } elsif ($ifile =~ /\.c$/) {
2043         $do_lit2pgm = 0; $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
2044         $hsc_out = $ifile; $is_hc_file = 0;
2045     } elsif ($ifile =~ /\.s$/) {
2046         $do_lit2pgm = 0; $do_hscpp = 0; $do_hsc = 0; $do_cc = 0;
2047         $cc_as = $ifile;
2048     } else { # don't know what it is, but nothing to do herein...
2049         $do_lit2pgm = 0; $do_hscpp = 0; $do_hsc = 0; $do_cc = 0; $do_as = 0;
2050     }
2051
2052     # OK, have a bash on the first two phases:
2053     &runLit2pgm($in_lit2pgm, $lit2pgm_hscpp)
2054         if $do_lit2pgm;
2055
2056     &runHscpp($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc)
2057         if $do_hscpp;
2058 \end{code}
2059
2060 We now think about whether to run hsc/cc or not (when hsc produces .s
2061 stuff, it effectively takes the place of both phases).
2062
2063 To get the output file name right: for each phase that we are {\em
2064 not} going to run, set its input (i.e., the output of its preceding
2065 phase) to @"$ifile_root.<suffix>"@.
2066 \begin{code}
2067     local($going_interactive) = $HscOut eq '-N=' || $ifile_root eq '_stdin';
2068
2069     if (! $do_cc && ! $do_as) { # stopping after hsc
2070         $hsc_out = ($Specific_output_file ne '')
2071                  ? $Specific_output_file
2072                  : &odir_ify($ifile_root, ($HscOut eq '-C=') ? 'hc' : 's');
2073
2074         $ofile_target = $hsc_out; # reset
2075     }
2076
2077     if (! $do_as) { # stopping after gcc (or hsc)
2078         $cc_as = ($Specific_output_file ne '')
2079                  ? $Specific_output_file
2080                  : &odir_ify($ifile_root, ( $Only_preprocess_C ) ? 'i' : 's');
2081
2082         $ofile_target = $cc_as; # reset
2083     }
2084
2085 \end{code}
2086
2087 Check if hsc needs to be run at all.
2088
2089 \begin{code}
2090     local($more_processing_required) = 1;
2091
2092     if ( $Do_recomp_chkr  && $do_hsc && ! $going_interactive ) {
2093         # recompilation-checking is important enough to live off by itself
2094         require('ghc-recomp.prl')
2095             || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-recomp.prl!\n");
2096
2097         $more_processing_required
2098             = &runRecompChkr($ifile, $hscpp_hsc, $ifile_root, $ofile_target, $hifile_target);
2099
2100         if ( ! $more_processing_required ) {
2101             print STDERR "$Pgm:recompile: NOT NEEDED!\n"; # Yay!
2102             # propagate dependency:
2103             &run_something("touch $ofile_target", "Touch $ofile_target, to propagate dependencies");
2104         }
2105     }
2106
2107     $do_hsc = 0, $do_cc = 0, $do_as = 0 if ! $more_processing_required;
2108 \end{code}
2109
2110 \begin{code}
2111     if ( $do_hsc ) {
2112
2113         &runHsc($ifile_root, $hsc_out, $hsc_hi, $going_interactive);
2114
2115         # interface-handling is important enough to live off by itself
2116         require('ghc-iface.prl')
2117             || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-iface.prl!\n");
2118
2119         &postprocessHiFile($hsc_hi, $hifile_target, $going_interactive);
2120
2121         # save a copy of the .hc file, even if we are carrying on...
2122         if ($HscOut eq '-C=' && $do_cc && $Keep_hc_file_too) {
2123             local($to_do) = "$Rm $ifile_root.hc; $Cp $hsc_out $ifile_root.hc";
2124             &run_something($to_do, 'Saving copy of .hc file');
2125         }
2126
2127         # save a copy of the .s file, even if we are carrying on...
2128         if ($HscOut eq '-S=' && $do_as && $Keep_s_file_too) {
2129             local($to_do) = "$Rm $ifile_root.s; $Cp $hsc_out $ifile_root.s";
2130             &run_something($to_do, 'Saving copy of .s file');
2131         }
2132
2133         # if we're going to split up object files,
2134         # we inject split markers into the .hc file now
2135         if ( $HscOut eq '-C=' && $SplitObjFiles ) {
2136             &inject_split_markers ( $hsc_out );
2137         }
2138     }
2139
2140     if ($do_cc) {
2141         &runGcc    ($is_hc_file, $hsc_out, $cc_as_o);
2142         &runMangler($is_hc_file, $cc_as_o, $cc_as, $ifile_root);
2143     }
2144
2145     &split_asm_file($cc_as)  if $do_as && $SplitObjFiles;
2146
2147     &runAs($as_out, $ifile_root) if $do_as;
2148 \end{code}
2149
2150 Finally, decide what to queue up for linker input.
2151 \begin{code}
2152     # tentatively assume we will eventually produce linker input:
2153     push(@Link_file, &odir_ify($ifile_root, 'o'));
2154
2155 #ToDo:    local($or_isuf) = ($Isuffix eq '') ? '' : "|$Isuffix";
2156
2157     if ( $ifile !~ /\.(lhs|hs|hc|c|s)$/ && $ifile !~ /_hc$/ ) {
2158         print STDERR "$Pgm: don't recognise suffix on `$ifile'; passing it through to linker\n"
2159             if $ifile !~ /\.a$/;
2160
2161         # oops; we tentatively pushed the wrong thing; fix & do the right thing
2162         pop(@Link_file); push(@Link_file, $ifile);
2163     }
2164
2165 } # end of ProcessInputFile
2166 \end{code}
2167
2168 %************************************************************************
2169 %*                                                                      *
2170 \section[Driver-run-phases]{Routines to run the various phases}
2171 %*                                                                      *
2172 %************************************************************************
2173
2174 \begin{code}
2175 sub runLit2pgm {
2176     local($in_lit2pgm, $lit2pgm_hscpp) = @_;
2177
2178     local($to_do) = "echo '#line 1 \"$in_lit2pgm\"' > $lit2pgm_hscpp && ".
2179                     "$Unlit @Unlit_flags $in_lit2pgm -  >> $lit2pgm_hscpp";
2180     @Files_to_tidy = ( $lit2pgm_hscpp );
2181
2182     &run_something($to_do, 'literate pre-processor');
2183 }
2184 \end{code}
2185
2186 \begin{code}
2187 sub runHscpp {
2188     local($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc) = @_;
2189
2190     local($to_do);
2191
2192     if ($HsCpp eq $Cat) {
2193         $to_do = "echo '#line 1 \"$in_lit2pgm\"' > $hscpp_hsc && ".
2194                         "$HsCpp $lit2pgm_hscpp >> $hscpp_hsc";
2195         @Files_to_tidy = ( $hscpp_hsc );
2196         &run_something($to_do, 'Ineffective C pre-processor');
2197     } else {
2198         local($includes) = '-I' . join(' -I',@Include_dir);
2199         $to_do = "echo '#line 1 \"$in_lit2pgm\"' > $hscpp_hsc && ".
2200                         "$HsCpp $Verbose $genSPECS_flag @HsCpp_flags -D__HASKELL1__=$Haskell1Version -D__GLASGOW_HASKELL__=$GhcVersionInfo $includes $lit2pgm_hscpp >> $hscpp_hsc";
2201         @Files_to_tidy = ( $hscpp_hsc );
2202         &run_something($to_do, 'Haskellised C pre-processor');
2203     }
2204 }
2205 \end{code}
2206
2207 \begin{code}
2208 sub runHsc {
2209     local($ifile_root, $hsc_out, $hsc_hi, $going_interactive) = @_;
2210
2211     # prepend comma to HsP flags (so hsc can tell them apart...)
2212     foreach $a ( @HsP_flags ) { $a = ",$a" unless $a =~ /^,/; }
2213
2214     &makeHiMap() unless $HiMapDone;
2215     push(@HsC_flags, "-himap=$HiMapFile");
2216
2217     # here, we may produce .hc/.s and/or .hi files
2218     local($output) = '';
2219     @Files_to_tidy = ();
2220
2221     if ( $going_interactive ) {
2222         # don't need .hi unless going to show it on stdout:
2223         $ProduceHi = '-nohifile=' if ! $HiOnStdout;
2224         $do_cc = 0; $do_as = 0; $Do_lnkr = 0; # and we won't go any further...
2225     }
2226
2227     # set up for producing output/.hi; note that flag twiddling
2228     # may mean that nothing will actually be produced:
2229     $output = "$ProduceHi$hsc_hi $HscOut$hsc_out";
2230     @Files_to_tidy = ( $hsc_hi, $hsc_out );
2231
2232     # if we're compiling foo.hs, we want the GC stats to end up in foo.stat
2233     if ( $CollectingGCstats ) {
2234         push(@HsC_rts_flags, "-S$ifile_root.stat");
2235         push(@Files_to_tidy, "$ifile_root.stat");
2236     }
2237
2238     if ( $CollectGhcTimings ) { # assume $RTS_style eq 'ghc'
2239         # emit nofibbish time/bytes-alloc stats to stderr;
2240         # see later .stat file post-processing
2241         push(@HsC_rts_flags, "-s$Tmp_prefix.stat");
2242         push(@Files_to_tidy, "$Tmp_prefix.stat");
2243     }
2244
2245     local($dump) = '';
2246     if ($Specific_dump_file ne '') {
2247         $dump = "2>> $Specific_dump_file";
2248         $Using_dump_file = 1;
2249     }
2250
2251     local($to_do);
2252     $to_do = "$HsC @HsP_flags ,$hscpp_hsc $dump @HsC_flags $CoreLint $Verbose $output +RTS @HsC_rts_flags";
2253     &run_something($to_do, 'Haskell compiler');
2254
2255     # finish business w/ nofibbish time/bytes-alloc stats
2256     &process_ghc_timings() if $CollectGhcTimings;
2257
2258     # if non-interactive, heave in the consistency info at the end
2259     # NB: pretty hackish (depends on how $output is set)
2260     if ( ! $going_interactive ) {
2261         if ( $HscOut eq '-C=' ) {
2262         $to_do = "echo 'static char ghc_hsc_ID[] = \"\@(#)hsc $ifile\t$HsC_major_version.$HsC_minor_version,$HsC_consist_options\";' >> $hsc_out";
2263
2264         } elsif ( $HscOut eq '-S=' ) {
2265             local($consist) = "hsc.$ifile.$HsC_major_version.$HsC_minor_version.$HsC_consist_options";
2266             $consist =~ s/,/./g;
2267             $consist =~ s/\//./g;
2268             $consist =~ s/-/_/g;
2269             $consist =~ s/[^A-Za-z0-9_.]/ZZ/g; # ToDo: properly?
2270             $to_do = "echo '\n\t.text\n$consist:' >> $hsc_out";
2271         }
2272         &run_something($to_do, 'Pin on Haskell consistency info');
2273     }
2274 }
2275 \end{code}
2276
2277 Use \tr{@Import_dir} and \tr{@SysImport_dir} to make a tmp file
2278 of (module-name, pathname) pairs, one per line, separated by a space.
2279 \begin{code}
2280 %HiMap     = ();
2281 $HiMapDone = 0;
2282 $HiMapFile = '';
2283
2284 sub makeHiMap {
2285
2286     # collect in %HiMap; write later; also used elsewhere in driver
2287
2288     local($mod, $path, $d, $e);
2289
2290     foreach $d ( @Import_dir ) {
2291         opendir(DIR, $d) || &tidy_up_and_die(1,"$Pgm: error when reading directory: $d\n");
2292         local(@entry) = readdir(DIR);
2293         foreach $e ( @entry ) {
2294             next unless $e =~ /\b([A-Z][A-Za-z0-9_]*)\.$HiSuffix$/o;
2295             $mod  = $1;
2296             $path = "$d/$e";
2297             $path =~ s,^\./,,;
2298
2299             if ( ! defined($HiMap{$mod}) ) {
2300                 $HiMap{$mod} = $path;
2301             } else {
2302                 &already_mapped_err($mod, $HiMap{$mod}, $path);
2303             }
2304         }
2305         closedir(DIR); # || &tidy_up_and_die(1,"$Pgm: error when closing directory: $d\n");
2306     }
2307
2308     foreach $d ( @SysImport_dir ) {
2309         opendir(DIR, $d) || &tidy_up_and_die(1,"$Pgm: error when reading directory: $d\n");
2310         local(@entry) = readdir(DIR);
2311         foreach $e ( @entry ) {
2312             next unless $e =~ /([A-Z][A-Za-z0-9_]*)\.$SysHiSuffix$/o;
2313             next if $NoImplicitPrelude && $e =~ /Prelude\.$SysHiSuffix$/o;
2314
2315             $mod  = $1;
2316             $path = "$d/$e";
2317             $path =~ s,^\./,,;
2318
2319             if ( ! defined($HiMap{$mod}) ) {
2320                 $HiMap{$mod} = $path;
2321             } elsif ( $mod ne 'Main' )  { # saves useless warnings...
2322                 &already_mapped_err($mod, $HiMap{$mod}, $path);
2323             }
2324         }
2325         closedir(DIR); # || &tidy_up_and_die(1,"$Pgm: error when closing directory: $d\n");
2326     }
2327
2328     $HiMapFile = "$Tmp_prefix.himap";
2329     unlink($HiMapFile);
2330     open(HIMAP, "> $HiMapFile") || &tidy_up_and_die(1,"$Pgm: can't open $HiMapFile\n");
2331     foreach $d (keys %HiMap) {
2332         print HIMAP $d, ' ', $HiMap{$d}, "\n";
2333     }
2334     close(HIMAP) || &tidy_up_and_die(1,"$Pgm: error when closing $HiMapFile\n");
2335
2336     $HiMapDone = 1;
2337 }
2338
2339 sub already_mapped_err {
2340     local($mod, $mapped_to, $path) = @_;
2341
2342     # OK, it isn't really an error if $mapped_to and $path turn
2343     # out to be the same thing.
2344     ($m_dev,$m_ino,$m_mode,$m_nlink,$m_uid,$m_gid,$m_rdev,$m_size,
2345      $m_atime,$m_mtime,$m_ctime,$m_blksize,$m_blocks) = stat($mapped_to);
2346     ($p_dev,$p_ino,$p_mode,$p_nlink,$p_uid,$p_gid,$p_rdev,$p_size,
2347      $p_atime,$p_mtime,$p_ctime,$p_blksize,$p_blocks) = stat($path);
2348
2349     return if $m_ino == $p_ino; # same inode number
2350
2351     print STDERR "$Pgm: module $mod already mapped to $mapped_to";
2352     print STDERR ";\n\tignoring: $path\n";
2353 }
2354 \end{code}
2355
2356 %************************************************************************
2357 %*                                                                      *
2358 \section[Driver-misc-utils]{Miscellaneous utilities}
2359 %*                                                                      *
2360 %************************************************************************
2361
2362 %************************************************************************
2363 %*                                                                      *
2364 \subsection[Driver-odir-ify]{@odir_ify@: Mangle filename if \tr{-odir} set}
2365 %*                                                                      *
2366 %************************************************************************
2367
2368 \begin{code}
2369 sub osuf_ify {
2370     local($ofile,$def_suffix) = @_;
2371
2372     return(($Osuffix eq '') ? "$ofile.$def_suffix" : "$ofile.$Osuffix" );
2373 }
2374
2375 sub odir_ify {
2376     local($orig_file, $def_suffix) = @_;
2377     if ($Specific_output_dir eq '') {   # do nothing
2378         &osuf_ify($orig_file, $def_suffix);
2379     } else {
2380         local ($orig_file_only);
2381         ($orig_file_only = $orig_file) =~ s|.*/||;
2382         &osuf_ify("$Specific_output_dir/$orig_file_only",$def_suffix);
2383     }
2384 }
2385 \end{code}
2386
2387 \begin{code}
2388 sub runGcc {
2389     local($is_hc_file, $hsc_out, $cc_as_o) = @_;
2390
2391     local($includes) = '-I' . join(' -I', @Include_dir);
2392     local($cc);
2393     local($s_output);
2394     local($c_flags) = "@CcBoth_flags";
2395     local($ddebug_flag) = ( $DEBUGging ) ? '-DDEBUG' : '';
2396
2397     # "input" files to use that are not in some weird directory;
2398     # to help C compilers grok .hc files [ToDo: de-hackify]
2399     local($cc_help)   = "ghc$$.c";
2400     local($cc_help_s) = "ghc$$.s";
2401
2402     $cc       = $CcRegd;
2403     $s_output = ($is_hc_file || $TargetPlatform =~ /^(hppa|i386)/) ? $cc_as_o : $cc_as;
2404     $c_flags .= " @CcRegd_flags";
2405     $c_flags .= ($is_hc_file) ? " @CcRegd_flags_hc"  : " @CcRegd_flags_c";
2406
2407     # C compiler won't like the .hc extension.  So we create
2408     # a tmp .c file which #include's the needful.
2409     open(TMP, "> $cc_help") || &tidy_up_and_die(1,"$Pgm: failed to open `$cc_help' (to write)\n");
2410     if ( $is_hc_file ) {
2411         print TMP <<EOINCL;
2412 #ifdef __STG_GCC_REGS__
2413 # if ! (defined(MAIN_REG_MAP) || defined(MARK_REG_MAP) || defined(SCAN_REG_MAP) || defined(SCAV_REG_MAP) || defined(FLUSH_REG_MAP))
2414 #  define MAIN_REG_MAP
2415 # endif
2416 #endif
2417 #include "stgdefs.h"
2418 EOINCL
2419         # user may have asked for #includes to be injected...
2420         print TMP @CcInjects if $#CcInjects >= 0;
2421     }
2422     # heave in the consistency info
2423     print TMP "static char ghc_cc_ID[] = \"\@(#)cc $ifile\t$Cc_major_version.$Cc_minor_version,$Cc_consist_options\";\n";
2424
2425     # and #include the real source
2426     print TMP "#include \"$hsc_out\"\n";
2427     close(TMP) || &tidy_up_and_die(1,"Failed writing to $cc_help\n");
2428
2429     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 )";
2430     # note: __GLASGOW_HASKELL__ is pointedly *not* #defined at the C level.
2431     if ( $Only_preprocess_C ) { # HACK ALERT!
2432         $to_do =~ s/ -S\b//g;
2433     }
2434     @Files_to_tidy = ( $cc_help, $cc_help_s, $s_output );
2435     $PostprocessCcOutput = 1;   # hack, dear hack...
2436     &run_something($to_do, 'C compiler');
2437     $PostprocessCcOutput = 0;
2438     unlink($cc_help, $cc_help_s);
2439 }
2440 \end{code}
2441
2442 \begin{code}
2443 sub runMangler {
2444     local($is_hc_file, $cc_as_o, $cc_as, $ifile_root) = @_;
2445
2446     if ( $is_hc_file ) {
2447         # dynamically load assembler-fiddling code, which we are about to use:
2448         require('ghc-asm.prl')
2449         || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm.prl!\n");
2450     }
2451
2452     print STDERR `cat $cc_as_o` if $Dump_raw_asm; # to stderr, before mangling
2453
2454     if ($is_hc_file) {
2455         # post-process the assembler [.hc files only]
2456         &mangle_asm($cc_as_o, $cc_as);
2457
2458 #OLD: for sanity:
2459 #OLD:   local($target) = 'oops';
2460 #OLD:   $target = '-alpha'      if $TargetPlatform =~ /^alpha-/;
2461 #OLD:   $target = '-hppa'       if $TargetPlatform =~ /^hppa/;
2462 #OLD:   $target = '-old-asm'    if $TargetPlatform =~ /^i386-/;
2463 #OLD:   $target = '-m68k'       if $TargetPlatform =~ /^m68k-/;
2464 #OLD:   $target = '-mips'       if $TargetPlatform =~ /^mips-/;
2465 #OLD:   $target = ''            if $TargetPlatform =~ /^powerpc-/;
2466 #OLD:   $target = '-solaris'    if $TargetPlatform =~ /^sparc-sun-solaris2/;
2467 #OLD:   $target = '-sparc'      if $TargetPlatform =~ /^sparc-sun-sunos4/;
2468 #OLD:
2469 #OLD:   if ( $target ne '' ) {
2470 #OLD:       require("ghc-asm$target.prl")
2471 #OLD:       || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm$target.prl!\n");
2472 #OLD:       &mangle_asm($cc_as_o, "$cc_as-2"); # the OLD one!
2473 #OLD:       &run_something("$Cmp -s $cc_as-2 $cc_as || $Diff $cc_as-2 $cc_as 1>&2 || exit 0",
2474 #OLD:           "Diff'ing old and new mangled .s files"); # NB: to stderr
2475 #OLD:   }
2476
2477     } elsif ($TargetPlatform =~ /^hppa/) {
2478         # minor mangling of non-threaded files for hp-pa only
2479         require('ghc-asm.prl')
2480         || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-hppa.prl!\n");
2481         &mini_mangle_asm_hppa($cc_as_o, $cc_as);
2482
2483     } elsif ($TargetPlatform =~ /^i386/) {
2484         # extremely-minor OFFENSIVE mangling of non-threaded just one file
2485         require('ghc-asm.prl')
2486         || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm.prl!\n");
2487         &mini_mangle_asm_i386($cc_as_o, $cc_as);
2488     }
2489
2490     # save a copy of the .s file, even if we are carrying on...
2491     if ($do_as && $Keep_s_file_too) {
2492         local($to_do) = "$Rm $ifile_root.s; $Cp $cc_as $ifile_root.s";
2493         &run_something($to_do, 'Saving copy of .s file');
2494     }
2495 }
2496 \end{code}
2497
2498 \begin{code}
2499 sub runAs {
2500     local($as_out, $ifile_root) = @_;
2501
2502     local($asmblr) = ( $As ) ? $As : $CcRegd;
2503
2504     if ( ! $SplitObjFiles ) {
2505         local($to_do)  = "$asmblr -o $as_out -c @As_flags $cc_as";
2506         @Files_to_tidy = ( $as_out );
2507         &run_something($to_do, 'Unix assembler');
2508
2509     } else { # more complicated split-ification...
2510
2511         # must assemble files $Tmp_prefix__[1 .. $NoOfSplitFiles].s
2512
2513         for ($f = 1; $f <= $NoOfSplitFiles; $f++ ) {
2514             local($split_out) = &odir_ify("${ifile_root}__${f}",'o');
2515             local($to_do) = "$asmblr -o $split_out -c @As_flags ${Tmp_prefix}__${f}.s";
2516             @Files_to_tidy = ( $split_out );
2517
2518             &run_something($to_do, 'Unix assembler');
2519         }
2520     }
2521 }
2522 \end{code}
2523
2524 %************************************************************************
2525 %*                                                                      *
2526 \subsection[Driver-run-something]{@run_something@: Run a phase}
2527 %*                                                                      *
2528 %************************************************************************
2529
2530 \begin{code}
2531 sub run_something {
2532     local($str_to_do, $tidy_name) = @_;
2533
2534     print STDERR "\n$tidy_name:\n\t" if $Verbose;
2535     print STDERR "$str_to_do\n" if $Verbose;
2536
2537     if ($Using_dump_file) {
2538         open(DUMP, ">> $Specific_dump_file")
2539             || &tidy_up_and_die(1,"$Pgm: failed to open `$Specific_dump_file'\n");
2540         print DUMP "\nCompilation Dump for: $str_to_do\n\n";
2541         close(DUMP)
2542             || &tidy_up_and_die(1,"$Pgm: failed closing `$Specific_dump_file'\n");
2543     }
2544
2545     local($return_val) = 0;
2546     system("$Time $str_to_do");
2547     $return_val = $?;
2548
2549     if ( $PostprocessCcOutput ) { # hack, continued
2550         open(CCOUT, "< $Tmp_prefix.ccout")
2551             || &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.ccout'\n");
2552         while ( <CCOUT> ) {
2553             next if /attribute directive ignored/;
2554             next if /call-clobbered/;
2555             next if /from .*COptRegs\.lh/;
2556             next if /from .*(stg|rts)defs\.h:/;
2557             next if /from ghc\d+.c:\d+:/;
2558             next if /from .*\.lc/;
2559             next if /from .*SMinternal\.l?h/;
2560             next if /ANSI C does not support \`long long\'/;
2561             next if /warning:.*was declared \`extern\' and later \`static\'/;
2562             next if /warning: assignment discards \`const\' from pointer target type/;
2563             next if /: At top level:$/;
2564             next if /: In function \`.*\':$/;
2565             next if /\`ghc_cc_ID\' defined but not used/;
2566             print STDERR $_;
2567         }
2568         close(CCOUT) || &tidy_up_and_die(1,"$Pgm: failed closing `$Tmp_prefix.ccout'\n");
2569     }
2570
2571     if ($return_val != 0) {
2572         if ($Using_dump_file) {
2573             print STDERR "Compilation Errors dumped in $Specific_dump_file\n";
2574         }
2575
2576         &tidy_up_and_die($return_val, '');
2577     }
2578     $Using_dump_file = 0;
2579 }
2580 \end{code}
2581
2582 %************************************************************************
2583 %*                                                                      *
2584 \subsection[Driver-ghctiming]{Emit nofibbish GHC timings}
2585 %*                                                                      *
2586 %************************************************************************
2587
2588 NB: nearly the same as in @runstdtest@ script.
2589
2590 \begin{code}
2591 sub process_ghc_timings {
2592     local($StatsFile) = "$Tmp_prefix.stat";
2593     local($SysSpecificTiming) = 'ghc';
2594
2595     open(STATS, $StatsFile) || die "Failed when opening $StatsFile\n";
2596     local($tot_live) = 0; # for calculating avg residency
2597
2598     while (<STATS>) {
2599         $tot_live += $1 if /^\s*\d+\s+\d+\s+\d+\.\d+\%\s+(\d+)\s+\d+\.\d+\%/;
2600
2601         $BytesAlloc = $1 if /^\s*([0-9,]+) bytes allocated in the heap/;
2602
2603         if ( /^\s*([0-9,]+) bytes maximum residency .* (\d+) sample/ ) {
2604             $MaxResidency = $1; $ResidencySamples = $2;
2605         }
2606
2607         $GCs = $1 if /^\s*([0-9,]+) garbage collections? performed/;
2608
2609         if ( /^\s*INIT\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2610             $InitTime = $1; $InitElapsed = $2;
2611         } elsif ( /^\s*MUT\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2612             $MutTime = $1; $MutElapsed = $2;
2613         } elsif ( /^\s*GC\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2614             $GcTime = $1; $GcElapsed = $2;
2615         }
2616     }
2617     close(STATS) || die "Failed when closing $StatsFile\n";
2618     if ( defined($ResidencySamples) && $ResidencySamples > 0 ) {
2619         $AvgResidency = int ($tot_live / $ResidencySamples) ;
2620     }
2621
2622     # warn about what we didn't find
2623     print STDERR "Warning: BytesAlloc not found in stats file\n" unless defined($BytesAlloc);
2624     print STDERR "Warning: GCs not found in stats file\n" unless defined($GCs);
2625     print STDERR "Warning: InitTime not found in stats file\n" unless defined($InitTime);
2626     print STDERR "Warning: InitElapsed not found in stats file\n" unless defined($InitElapsed);
2627     print STDERR "Warning: MutTime not found in stats file\n" unless defined($MutTime);
2628     print STDERR "Warning: MutElapsed not found in stats file\n" unless defined($MutElapsed);
2629     print STDERR "Warning: GcTime inot found in stats file\n" unless defined($GcTime);
2630     print STDERR "Warning: GcElapsed not found in stats file\n" unless defined($GcElapsed);
2631
2632     # things we didn't necessarily expect to find
2633     $MaxResidency     = 0 unless defined($MaxResidency);
2634     $AvgResidency     = 0 unless defined($AvgResidency);
2635     $ResidencySamples = 0 unless defined($ResidencySamples);
2636
2637     # a bit of tidying
2638     $BytesAlloc =~ s/,//g;
2639     $MaxResidency =~ s/,//g;
2640     $GCs =~ s/,//g;
2641     $InitTime =~ s/,//g;
2642     $InitElapsed =~ s/,//g;
2643     $MutTime =~ s/,//g;
2644     $MutElapsed =~ s/,//g;
2645     $GcTime =~ s/,//g;
2646     $GcElapsed =~ s/,//g;
2647
2648     # print out what we found
2649     print STDERR "<<$SysSpecificTiming: ",
2650         "$BytesAlloc bytes, $GCs GCs, $AvgResidency/$MaxResidency avg/max bytes residency ($ResidencySamples samples), $InitTime INIT ($InitElapsed elapsed), $MutTime MUT ($MutElapsed elapsed), $GcTime GC ($GcElapsed elapsed)",
2651         " :$SysSpecificTiming>>\n";
2652
2653     # OK, party over
2654     unlink $StatsFile;
2655 }
2656 \end{code}
2657
2658 %************************************************************************
2659 %*                                                                      *
2660 \subsection[Driver-dying]{@tidy_up@ and @tidy_up_and_die@: Dying gracefully}
2661 %*                                                                      *
2662 %************************************************************************
2663
2664 \begin{code}
2665 sub tidy_up {
2666     local($to_do) = "\n$Rm $Tmp_prefix*";
2667     if ( $Tmp_prefix !~ /^\s*$/ ) {
2668         print STDERR "$to_do\n" if $Verbose;
2669         system($to_do);
2670     }
2671 }
2672
2673 sub tidy_up_and_die {
2674     local($return_val, $msg) = @_;
2675
2676     # delete any files to tidy
2677     print STDERR "deleting... @Files_to_tidy\n" if $Verbose && $#Files_to_tidy >= 0;
2678     unlink @Files_to_tidy if $#Files_to_tidy >= 0;
2679
2680     &tidy_up();
2681     print STDERR $msg;
2682     exit (($return_val == 0) ? 0 : 1);
2683 }
2684 \end{code}
2685
2686 %************************************************************************
2687 %*                                                                      *
2688 \subsection[Driver-arg-with-arg]{@grab_arg_arg@: Do an argument with an argument}
2689 %*                                                                      *
2690 %************************************************************************
2691
2692 Some command-line arguments take an argument, e.g.,
2693 \tr{-Rmax-heapsize} expects a number to follow.  This can either be
2694 given a part of the same argument (\tr{-Rmax-heapsize8M}) or as the
2695 next argument (\tr{-Rmax-heapsize 8M}).  We allow both cases.
2696
2697 Note: no error-checking; \tr{-Rmax-heapsize -Rgc-stats} will silently
2698 gobble the second argument (and probably set the heapsize to something
2699 nonsensical).
2700 \begin{code}
2701 sub grab_arg_arg {
2702     local($option, $rest_of_arg) = @_;
2703
2704     if ($rest_of_arg) {
2705         return($rest_of_arg);
2706     } elsif ($#ARGV >= 0) {
2707         local($temp) = $ARGV[0]; shift(@ARGV);
2708         return($temp);
2709     } else {
2710         print STDERR "$Pgm: no argument following $option option\n";
2711         $Status++;
2712     }
2713 }
2714 \end{code}
2715
2716 \begin{code}
2717 sub isntAntiFlag {
2718     local($flag) = @_;
2719     local($f);
2720
2721 #Not in HsC_antiflag ## NO!: and not already in HsC_flags
2722
2723     foreach $f ( @HsC_antiflags ) {
2724         return(0) if $flag eq $f;
2725     }
2726 #    foreach $f ( @HsC_flags ) {
2727 #       return(0) if $flag eq $f;
2728 #    }
2729     return(1);
2730 }
2731
2732 sub squashHscFlag {  # pretty terrible
2733     local($flag) = @_;
2734     local($f);
2735
2736     foreach $f ( @HsC_flags ) {
2737         if ($flag eq $f) { $f = ''; }
2738     }
2739 }
2740
2741 sub add_Hsc_flags {
2742     local(@flags) = @_;
2743     local($f);
2744
2745     foreach $f ( @flags ) {
2746         push( @HsC_flags, $f ) if &isntAntiFlag($f);
2747     }
2748 }
2749 \end{code}
2750