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