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