ghc/driver/ghc.lprl

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