2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1997
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.
9 %************************************************************************
11 \section[Driver-usage]{Usage message}
13 %************************************************************************
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:
21 $Pgm [command-line-options-and-input-files]
23 ------------------------------------------------------------------------
24 This driver ($Pgm) guides each input file through (some of the)
25 possible phases of a compilation:
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
34 For each input file, the phase to START with is determined by the
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
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).
47 The phase at which to STOP processing is determined by a command-line
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)
54 Other commonly-used options are:
56 -O An `optimising' package of compiler flags, for faster code
58 -prof Compile for cost-centre profiling
59 (add -auto for automagic cost-centres on top-level functions)
61 -fglasgow-exts Allow Glasgow extensions (unboxed types, etc.)
63 -H14m Increase compiler's heap size
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
71 The User's Guide has more information about GHC's *many* options.
73 Given the above, here are some TYPICAL invocations of $Pgm:
75 # compile a Haskell module to a .o file, optimising:
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:
83 ------------------------------------------------------------------------
87 %************************************************************************
89 \section[Driver-init]{Initialisation}
91 %************************************************************************
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:
100 HOSTPLATFORM TARGETPLATFORM
102 PROJECTNAME PROJECTVERSION PROJECTPATCHLEVEL
106 bindir libdir libexecdir datadir
110 GHC_LIB_DIR GHC_RUNTIME_DIR GHC_UTILS_DIR GHC_INCLUDE_DIR
112 GHC_OPT_HILEV_ASM GhcWithNativeCodeGen
114 GHC_UNLIT GHC_HSCPP GHC_HSC GHC_SYSMAN
118 WAY_*_NAME WAY_*_HC_OPTS
124 Establish what executables to run for the various phases, what the
125 default options are for those phases, and other similar boring stuff.
128 select(STDERR); $| = 1; select(STDOUT); # no STDERR buffering, please.
130 $TargetPlatform = $TARGETPLATFORM;
132 $TopPwd = "${TOP_PWD}";
133 $InstBinDirGhc = "${bindir}";
134 $InstLibDirGhc = "${libdir}";
136 # Normally the same as InstLibDirGhc, but we accommodate
137 # for it being separate.
139 $InstLibExecDirGhc = "${libexecdir}";
140 $InstDataDirGhc = "${datadir}";
141 $InstSysLibDir = ( $INSTALLING ) ? "${InstLibDirGhc}/hslibs" : "$TopPwd/hslibs";
143 $Status = 0; # just used for exit() status
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';
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}" );
156 if ( $ENV{'TMPDIR'} ) { # where to make tmp file names
157 $Tmp_prefix = ($ENV{'TMPDIR'} . "/ghc$$");
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
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 :-)
177 if ( ! $ENV{'REAL_SHELL'} ) {
178 $ENV{'REAL_SHELL'} = $ENV{'SHELL'};
181 @Files_to_tidy = (); # files we nuke in the case of abnormal termination
183 $Unlit = ( $INSTALLING ) ? "$InstLibExecDirGhc/unlit"
184 : "$TopPwd/${CURRENT_DIR}/${GHC_UNLIT}";
188 $Diff = $CONTEXT_DIFF;
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}";
198 $genSPECS_flag = ''; # See ../utils/hscpp/hscpp.prl
199 $HsC = ( $INSTALLING ) ? "$InstLibExecDirGhc/hsc"
200 : "$TopPwd/${CURRENT_DIR}/${GHC_HSC}";
202 # For PVM fiends only
203 $SysMan = ( $INSTALLING ) ? "$InstLibExecDirGhc/SysMan"
204 : "$TopPwd/${CURRENT_DIR}/${GHC_SYSMAN}";
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.
213 $Specific_heap_size = 6 * 1000 * 1000;
214 $Specific_stk_size = 1000 * 1000;
215 $Scale_sizes_by = 1.0;
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.
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 = '';
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
240 # Assign defaults to these right away.
244 Things to do with C compilers/etc:
246 $CcRegd = $GHC_OPT_HILEV_ASM;
247 @CcBoth_flags = ('-S'); # flags for *any* C compilation
251 # those for all files,
252 # those only for .c files;
253 # those only for .hc files
255 @CcRegd_flags = ('-ansi', '-D__STG_GCC_REGS__', '-D__STG_TAILJUMPS__');
256 @CcRegd_flags_c = ();
257 @CcRegd_flags_hc = ();
259 $As = ''; # "assembler" is normally GCC
262 $Lnkr = ''; # "linker" is normally GCC
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';
270 What options \tr{-user-setup-a} turn into (user-defined ``packages''
271 of options). Note that a particular user-setup implies a particular
272 Prelude ({\em including} its interface file(s)).
274 $BuildTag = ''; # default is sequential build w/ Appel-style GC
276 %BuildDescr = (# system ways begin
277 '', 'normal sequential',
281 '_mc', "$WAY_mc_NAME",
282 '_mr', "$WAY_mr_NAME",
283 '_mt', "$WAY_mt_NAME",
284 '_mp', "$WAY_mp_NAME",
285 '_mg', "$WAY_mg_NAME",
286 '_2s', "$WAY_2s_NAME",
287 '_1s', "$WAY_1s_NAME",
288 '_du', "$WAY_du_NAME",
306 '_B', "$WAY_B_NAME" );
308 # these are options that are "fed back" through the option processing loop
312 '_a', "$WAY_a_HC_OPTS",
313 '_b', "$WAY_b_HC_OPTS",
314 '_c', "$WAY_c_HC_OPTS",
315 '_d', "$WAY_d_HC_OPTS",
316 '_e', "$WAY_e_HC_OPTS",
317 '_f', "$WAY_f_HC_OPTS",
318 '_g', "$WAY_g_HC_OPTS",
319 '_h', "$WAY_h_HC_OPTS",
320 '_i', "$WAY_i_HC_OPTS",
321 '_j', "$WAY_j_HC_OPTS",
322 '_k', "$WAY_k_HC_OPTS",
323 '_l', "$WAY_l_HC_OPTS",
324 '_m', "$WAY_m_HC_OPTS",
325 '_n', "$WAY_n_HC_OPTS",
326 '_o', "$WAY_o_HC_OPTS",
327 '_A', "$WAY_A_HC_OPTS",
328 '_B', "$WAY_B_HC_OPTS",
331 '_p', "$WAY_p_HC_OPTS",
332 '_t', "$WAY_t_HC_OPTS",
333 '_u', "$WAY_u_HC_OPTS",
334 '_mc', "$WAY_mc_HC_OPTS",
335 '_mr', "$WAY_mr_HC_OPTS",
336 '_mt', "$WAY_mt_HC_OPTS",
337 '_mp', "$WAY_mp_HC_OPTS",
338 '_mg', "$WAY_mg_HC_OPTS",
339 '_2s', "$WAY_2s_HC_OPTS",
340 '_1s', "$WAY_1s_HC_OPTS",
341 '_du', "$WAY_B_HC_OPTS" );
345 Import/include directories (\tr{-I} options) are sufficiently weird to
346 require special handling.
349 @Import_dir = ('.'); #-i things
350 @Include_dir = ('.'); #-I things; other default(s) stuck on AFTER option processing
352 # where to look for interface files (system hi's, i.e., prelude and hslibs)
353 @SysImport_dir = ( $INSTALLING )
354 ? ( "$InstLibDirGhc/imports" )
355 : ( "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/required"
356 , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/ghc"
357 , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/glaExts"
358 , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/concurrent" );
360 # We need to look in ghc/ and glaExts/ when searching for implicitly needed .hi files, but
361 # we should really *not* look there for explicitly imported modules.
363 $GhcVersionInfo = int($PROJECTVERSION * 100 + .5); # i.e., round (X.Y * 100)
364 $Haskell1Version = 4; # i.e., Haskell 1.4
367 @UserLibrary_dir= (); #-L things;...
368 @UserLibrary = (); #-l things asked for by the user
370 @SysLibrary_dir = ( ( $INSTALLING ) #-syslib things supplied by the system
372 : ( "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR"
373 , "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR/gmp"
374 , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR"
375 , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/cbits"
378 @SysLibrary = (); # will be built up as we go along
380 $TopClosureFile # defaults to 1.2 one; will be mangled later
381 = ( $INSTALLING) ? "$InstLibDirGhc/TopClosureXXXX.o"
382 : "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR/main/TopClosureXXXX.o";
384 # make depend for Haskell
386 = ( $INSTALLING ) ? "$InstBinDirGhc/mkdependHS"
387 : "$TopPwd/$CURRENT_DIR/$GHC_UTILS_DIR/mkdependHS/mkdependHS";
389 @MkDependHS_flags = ();
391 # do_link flag should not be reset while rescanning the cmd-line.
393 $Specific_output_dir = ''; # set by -odir <dir>
394 $Specific_output_file = ''; # set by -o <file>; "-" for stdout
397 Function to initialise the per-compilation-unit globals that
398 are used to guide and control the invocation of the different phases.
401 sub initDriverGlobals {
403 # reset the following options:
404 # RTS flags to use while compiling
406 @HsP_flags = (); # these are the flags destined solely for
407 # the flex/yacc parser
412 The optimisations/etc to be done by the compiler are {\em normally}
413 expressed with a \tr{-O} (or \tr{-O2}) flag, or by its absence.
416 $OptLevel = 0; # no -O == 0; -O == 1; -O2 == 2; -Ofile == 3
417 $MinusO2ForC = 0; # set to 1 if -O2 should be given to C compiler
418 $StolenX86Regs = 4; # **HACK*** of the very worst sort
422 @CcBoth_flags = ('-S'); # flags for *any* C compilation
425 # GCC flags: those for all files, those only for .c files; those only for .hc files
426 @CcRegd_flags = ('-ansi', '-D__STG_GCC_REGS__', '-D__STG_TAILJUMPS__');
427 @CcRegd_flags_c = ();
428 @CcRegd_flags_hc = ();
430 @Import_dir = ('.'); #-i things
431 @Include_dir = ('.'); #-I things; other default(s) stuck on AFTER option processing
436 We are given a list of files with various presumably-known suffixes
437 (unknown-suffix files go straight to the linker). For each file, we
438 begin by assuming that we'll run every phase over it. However: (1)
439 global flags (\tr{-c}, \tr{-S}, etc.) tell us not to run any phase
440 past a certain point; and (2) the file's suffix tells us what phase to
441 start with. Linking is weird and kept track of separately.
443 Here are the initial defaults applied to all files:
445 $Cpp_flag_set = 0; # (hack)
446 $Only_preprocess_C = 0; # pretty hackish
447 $Only_preprocess_hc = 0; # ditto
448 $Only_generate_deps = 0; # "
449 $PostprocessCcOutput = 0;
451 # native code-gen or via C?
452 $HaveNativeCodeGen = $GhcWithNativeCodeGen;
453 $HscOut = '-C='; # '-C=' ==> .hc output; '-S=' ==> .s output; '-N=' ==> neither
455 if $HaveNativeCodeGen && $TargetPlatform =~ /^(alpha|sparc)-/;
456 # TEMP: disable x86 if $HaveNativeCodeGen && $TargetPlatform =~ /^(i386|alpha|sparc)-/;
457 $ProduceHi = '-hifile=';
462 $CollectingGCstats = 0;
463 $CollectGhcTimings = 0;
464 $DEBUGging = ''; # -DDEBUG and all that it entails (um... not really)
465 $PROFing = ''; # set to p or e if profiling
466 $PROFgroup = ''; # set to group if an explicit -Ggroup specified
467 $PROFauto = ''; # set to relevant hsc flag if -auto or -auto-all
468 $PROFcaf = ''; # set to relevant hsc flag if -caf-all
469 $PROFignore_scc = ''; # set to relevant parser flag if explicit sccs ignored
470 $UNPROFscc_auto = ''; # set to relevant hsc flag if forcing auto sccs without profiling
471 $TICKYing = ''; # set to t if compiling for ticky-ticky profiling
472 $PARing = ''; # set to p if compiling for PAR
473 $CONCURing = ''; # set to c if compiling for CONCURRENT
474 $GRANing = ''; # set to g if compiling for GRAN
475 $StkChkByPageFaultOK = 1; # may be set to 0 (false) for some builds
476 $Specific_hi_file = ''; # set by -ohi <file>; "-" for stdout
477 $Specific_dump_file = ''; # set by -odump <file>; "-" for stdout
478 $Using_dump_file = 0;
480 $Osuffix = ''; # default: use the normal suffix for that kind of output
482 $HiSuffix_prelude = '';
483 $Do_recomp_chkr = 0; # don't use the recompilatio checker unless asked
484 $Do_cc = -1; # a MAGIC indeterminate value; will be set to 1 or 0.
487 $Keep_hc_file_too = 0;
488 $Keep_s_file_too = 0;
489 $UseGhcInternals = 0; # if 1, may use GHC* modules
492 $Dump_parser_output = 0;
494 $Dump_asm_splitting_info = 0;
495 $NoImplicitPrelude = 0;
498 } # end of initDriverGlobals (Sigh)
500 # we split the argv passed to the driver into three:
505 # and files to be linked...
511 # cmd line options prefixing the unit we're compiling
516 We inject consistency-checking information into \tr{.hc} files (both
517 when created by the Haskell compiler and when compiled by the C
518 compiler), so that we can check that an executable is made from
519 consistently-built pieces. (The check is normally done just after
520 linking.) The checking is done by introducing/munging
521 \tr{what(1)}-style strings. Anyway, here are the relevant global
522 variables and their defaults:
524 $LinkChk = 1; # set to 0 if the link check should *not* be done
526 # major & minor version numbers; major numbers must always agree;
527 # minor disagreements yield a warning.
528 $HsC_major_version = 33;
529 $HsC_minor_version = 0;
530 $Cc_major_version = 36;
531 $Cc_minor_version = 1;
533 # options: these must always agree
534 $HsC_consist_options = ''; # we record, in this order:
535 # Build tag; debugging?
536 $Cc_consist_options = ''; # we record, in this order:
537 # Build tag; debugging?
540 %************************************************************************
542 \section[Driver-parse-argv]{Munge the command-line options}
544 %************************************************************************
546 Now slurp through the arguments.
549 #---------- user defined prelude ---------------------------------------
551 if (grep(/^-user-prelude$/, @ARGV)) {
553 # If ARGV contains -user-prelude we are compiling a piece of
554 # prelude for the user, probably with additional specialise pragmas
556 # We strip out the -O -f and -user-prelude flags provided on
557 # the command line and add the ones used to compile the prelude
558 # ToDo: get these options from a common definition in mkworld
560 # We also enable any options forced through with -user-prelude-force
562 # Hey, Check out this grep statement ;-) (PS)
564 @ARGV = grep((!/^-O/ && !/^-f/ && !/^-user-prelude$/) || s/^-user-prelude-force//,
568 '-fcompiling-ghc-internals=???', # ToDo!!!!
570 '-fshow-pragma-name-errs',
571 '-fshow-import-specs',
577 print STDERR "ghc: -user-prelude options:\n", "@ARGV", "\n";
580 &initDriverGlobals();
581 &splitCmdLine(@ARGV);
582 # Run through the cmd-line first time.
583 &processArgs(@Cmd_opts);
585 # Check to see if driver is only in the business
586 # to generate dependencies
587 if ( $Status == 0 && $Only_generate_deps ) {
589 push (@MkDependHS_flags, "-o$Osuffix") if $Osuffix;
590 push (@MkDependHS_flags, "-s$BuildTag") if $BuildTag;
591 push (@MkDependHS_flags, "-D__HASKELL1__=$Haskell1Version");
592 local($to_do) = "$MkDependHS @MkDependHS_flags -- @Cmd_opts -- @Input_file" ;
593 &run_something($to_do, 'Haskell dependencies');
597 # if there are several input files,
598 # we don't allow \tr{-o <file>} or \tr{-ohi <file>} options...
599 # (except if linking, of course)
601 if ($#Input_file > 0 && ( ! $Do_lnkr )) {
602 if ( ($Specific_output_file ne '' && $Specific_output_file ne '-')
603 || ($Specific_hi_file ne '' && $Specific_hi_file ne '-') ) {
604 print STDERR "$Pgm: You can't use -o or -ohi options if you have multiple input files.\n";
605 print STDERR "\tPerhaps the -odir option will do what you want.\n";
610 # check for various pathological -o and -odir combinations...
611 if ($Specific_output_dir ne '' && $Specific_output_file ne '') {
612 if ($Specific_output_file eq '-') {
613 print STDERR "$Pgm: can't set output directory with -ohi AND have output to stdout\n";
615 } else { # amalgamate...
616 $Specific_output_file = "$Specific_output_dir/$Specific_output_file";
617 # ToDo: check we haven't got a junk name now...
618 $Specific_output_dir = ''; # reset
622 # crash and burn if there were errors
624 print STDERR $ShortUsage;
629 %************************************************************************
631 \section[Driver-post-argv-mangling]{Setup after reading options}
633 %************************************************************************
635 %************************************************************************
637 \subsection{Set up for optimisation level (\tr{-O} or whatever)}
639 %************************************************************************
641 We come now to the default ``wads of options'' that are turned on by
642 \tr{-O0} (do min optimisation), \tr{-O} (ordinary optimisation),
643 \tr{-O2} (aggressive optimisation), or no O-ish flag (compile speed is
646 The user can also specify his/her own list of options in a file; in
647 that case, the work is already done (see stuff about @minusO3@,
650 GHC allows very precise control of what happens during a compilation.
651 Core-to-Core and STG-to-STG passes can be run in any order, as many
652 times as you like. Individual transformations can be turned on or
655 Sadly, however, there are some interdependencies \& Things You Must
656 Not Do. Here is the list.
660 \item[\tr{-fspecialise}:]
661 The specialiser must have dependency-analysed input; but if you run
662 the simplifier to do this, you must not let it toss away unused
663 bindings! (The typechecker conveys some specialisation info via
664 ``unused'' bindings...)
666 \item[\tr{-ffloat-inwards}:]
667 Floating inwards should be done before strictness analysis, because
668 the latter will give better results.
670 \item[\tr{-fstatic-args}:]
671 The static-arguments-transformation pass {\em must} have the
672 simplifier run right after it.
674 \item[\tr{-fcalc-inlinings[12]}:]
675 Not required, but there may be slight gains by re-simplifying after
676 this is done. (You could then \tr{-fcalc-inlinings} again, just for
679 \item[\tr{-ffull-laziness}:]
680 The (outwards-)let-floater should be the {\em last} Core-to-Core pass
681 that's run. (Um, well, howzabout the simplifier just once more...)
686 \item[\tr{-fupdate-analysis}:]
687 It really really wants to be the last STG-to-STG pass that is run.
692 sub setupOptimiseFlags {
698 '-ffloat-lets-exposing-whnf',
699 '-ffloat-primops-ok',
702 # '-fdo-lambda-eta-expansion', # too complicated
704 # '-flet-to-case', # no strictness analysis, so...
705 $Oopt_PedanticBottoms,
706 # $Oopt_MonadEtaExpansion, # no thanks
708 # These two work fine, if you really want no simplification at all,
709 # for bizarre test reasons. But you get really terrible code if you use them,
710 # for example: let x = e in x
711 # with dozens of redundant thunks etc. So I'm leaving them out.
713 # '-fsimpl-uf-use-threshold0',
714 # '-fessential-unfoldings-only',
716 $Oopt_UnfoldingUseThreshold,
717 $Oopt_MaxSimplifierIterations,
718 $Oopt_ShowSimplifierProgress,
721 # '-ffull-laziness', # removed 95/04 WDP following Andr\'e's lead
723 $Oopt_FinalStgProfilingMassage
726 @HsC_minusO_flags # NOTE: used for *both* -O and -O2 (some conditional bits)
728 '-fdo-eta-reduction',
730 # initial simplify: mk specialiser happy: minimum effort please
734 '-fkeep-spec-pragma-ids', # required before specialisation
736 # I don't understand why we want -fessential-unfoldings-only here
737 # If we have it, the following nasty thing happens:
741 # where "*" means exported.
742 # In the essential-unfoldings pass we still substitute f for g
743 # but we don't substitute E for f first. So we get
747 # The g=f will get reverse-substituted later, but it's untidy.
749 # '-fessential-unfoldings-only',
750 # '-fsimpl-uf-use-threshold0',
752 '-fmax-simplifier-iterations1',
753 $Oopt_PedanticBottoms,
756 ($Oopt_DoSpecialise) ? (
757 '-fspecialise-overloaded',
758 $Oopt_SpecialiseUnboxed,
762 '-fsimplify', # need dependency anal after specialiser ...
763 '[', # need tossing before calc-inlinings ...
765 '-ffloat-lets-exposing-whnf',
766 '-ffloat-primops-ok',
770 # '-fdo-eta-reduction',
771 '-fdo-lambda-eta-expansion',
773 $Oopt_PedanticBottoms,
774 $Oopt_MonadEtaExpansion,
775 $Oopt_UnfoldingUseThreshold,
776 $Oopt_MaxSimplifierIterations,
777 $Oopt_ShowSimplifierProgress,
780 #LATER: '-fcalc-inlinings1', -- pointless for 2.01
782 # ($Oopt_FoldrBuildWW) ? (
783 # '-ffoldr-build-ww-anal',
784 # '-ffoldr-build-worker-wrapper',
788 # '-ffloat-lets-exposing-whnf',
789 # '-ffloat-primops-ok',
793 # '-fdo-eta-reduction',
794 # '-fdo-lambda-eta-expansion',
796 # $Oopt_PedanticBottoms,
797 # $Oopt_MonadEtaExpansion,
798 # $Oopt_UnfoldingUseThreshold,
799 # $Oopt_MaxSimplifierIterations,
800 # $Oopt_ShowSimplifierProgress,
804 # this pass-ordering sequence was agreed by Simon and Andr\'e
805 # (WDP 94/07, 94/11).
808 ($Oopt_FoldrBuild) ? (
809 '-ffoldr-build-on', # desugar list comprehensions for foldr/build
813 '-fignore-inline-pragma', # **** NB!
814 '-fdo-foldr-build', # NB
816 '-ffloat-lets-exposing-whnf',
817 '-ffloat-primops-ok',
821 # '-fdo-eta-reduction',
822 '-fdo-lambda-eta-expansion', # After full laziness
824 $Oopt_PedanticBottoms,
825 $Oopt_MonadEtaExpansion,
826 $Oopt_UnfoldingUseThreshold,
827 $Oopt_MaxSimplifierIterations,
828 $Oopt_ShowSimplifierProgress,
837 '-ffloat-lets-exposing-whnf',
838 '-ffloat-primops-ok',
842 '-fdo-eta-reduction',
843 '-fdo-lambda-eta-expansion',
845 ($Oopt_FoldrBuildInline),
846 # you need to inline foldr and build
847 ($Oopt_FoldrBuild) ? ('-fdo-foldr-build') : (),
848 # but do reductions if you see them!
849 $Oopt_PedanticBottoms,
850 $Oopt_MonadEtaExpansion,
851 $Oopt_UnfoldingUseThreshold,
852 $Oopt_MaxSimplifierIterations,
853 $Oopt_ShowSimplifierProgress,
861 '-ffloat-lets-exposing-whnf',
862 '-ffloat-primops-ok',
866 # '-fdo-eta-reduction',
867 '-fdo-lambda-eta-expansion',
869 '-flet-to-case', # Aha! Only done after strictness analysis
870 $Oopt_PedanticBottoms,
871 $Oopt_MonadEtaExpansion,
872 $Oopt_UnfoldingUseThreshold,
873 $Oopt_MaxSimplifierIterations,
874 $Oopt_ShowSimplifierProgress,
879 # Case-liberation for -O2. This should be after
880 # strictness analysis and the simplification which follows it.
884 # : "-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 ]" ),
886 # Final clean-up simplification:
891 '-ffloat-lets-exposing-whnf',
892 '-ffloat-primops-ok',
896 # '-fdo-eta-reduction',
897 '-fdo-lambda-eta-expansion',
900 '-fignore-inline-pragma', # **** NB!
901 $Oopt_FoldrBuildInline,
902 ($Oopt_FoldrBuild) ? ('-fdo-foldr-build') : (),
903 # but still do reductions if you see them!
904 $Oopt_PedanticBottoms,
905 $Oopt_MonadEtaExpansion,
906 $Oopt_UnfoldingUseThreshold,
907 $Oopt_MaxSimplifierIterations,
908 $Oopt_ShowSimplifierProgress,
913 #LATER: '-fcalc-inlinings2', -- pointless for 2.01
918 $Oopt_FinalStgProfilingMassage,
924 # SPECIAL FLAGS for -O2
932 Sort out what we're going to do about optimising. First, the @hsc@
933 flags and regular @cc@ flags to worry about:
935 if ( $OptLevel <= 0 ) {
937 # for this level, we tell the parser -fignore-interface-pragmas
938 push(@HsC_flags, '-fignore-interface-pragmas');
939 # and tell the compiler not to produce them
940 push(@HsC_flags, '-fomit-interface-pragmas');
942 &add_Hsc_flags( @HsC_minusNoO_flags );
943 push(@CcBoth_flags, ($MinusO2ForC) ? '-O2' : '-O'); # not optional!
945 } elsif ( $OptLevel == 1 || $OptLevel == 2 ) {
947 &add_Hsc_flags( @HsC_minusO_flags );
948 push(@CcBoth_flags, ($MinusO2ForC || $OptLevel == 2) ? '-O2' : '-O'); # not optional!
949 # -O? to GCC is not optional! -O2 probably isn't worth it generally,
950 # but it *is* useful in compiling the garbage collectors (so said
951 # Patrick many moons ago...).
953 } else { # -Ofile, then...
955 &add_Hsc_flags( @HsC_minusO3_flags );
956 push(@HsC_flags, $Oopt_FinalStgProfilingMassage) if $Oopt_FinalStgProfilingMassage;
958 push(@CcBoth_flags, ($MinusO2ForC) ? '-O2' : '-O'); # possibly to be elaborated...
961 } # setupOptimiseFlags
965 %************************************************************************
967 \subsection{Check for consistency, etc.}
969 %************************************************************************
971 Sort out @$BuildTag@, @$PROFing@, @$CONCURing@, @$PARing@,
972 @$GRANing@, @$TICKYing@:
974 sub setupBuildFlags {
977 # PROFILING stuff after argv mangling:
979 # warn about any scc exprs found (in case scc used as identifier)
980 push(@HsP_flags, '-W');
982 # add -auto sccs even if not profiling !
983 push(@HsC_flags, $UNPROFscc_auto) if $UNPROFscc_auto;
986 push(@HsC_flags, $PROFauto) if $PROFauto;
987 push(@HsC_flags, $PROFcaf) if $PROFcaf;
988 #push(@HsC_flags, $PROFdict) if $PROFdict;
990 $Oopt_FinalStgProfilingMassage = '-fmassage-stg-for-profiling';
992 push(@HsP_flags, (($PROFignore_scc) ? $PROFignore_scc : '-S'));
994 if ( $SplitObjFiles ) {
995 # can't split with cost centres -- would need global and externs
996 print STDERR "$Pgm: WARNING: splitting objects when profiling will *BREAK* if any _scc_s are present!\n";
997 # (but it's fine if there aren't any _scc_s around...)
998 # $SplitObjFiles = 0; # unset
999 #not an error: for now: $Status++;
1002 #if ( $BuildTag ne '' ) {
1003 # local($b) = $BuildDescr{$BuildTag};
1004 # if ($CONCURing eq 'c') { print STDERR "$Pgm: Can't mix $b with -concurrent.\n"; exit 1; }
1005 # if ($PARing eq 'p') { print STDERR "$Pgm: Can't mix $b with -parallel.\n"; exit 1; }
1006 # if ($GRANing eq 'g') { print STDERR "$Pgm: Can't mix $b with -gransim.\n"; exit 1; }
1007 # if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix $b with -ticky.\n"; exit 1; }
1009 # # ok to have a user-way profiling build
1010 # # eval the profiling opts ... but leave user-way BuildTag
1011 # if ($PROFing eq 'p') { &processArgs(split(' ', $SetupOpts{'_p'})); } # eval($EvaldSetupOpts{'_p'}); }
1013 if ( $PROFing eq 'p' ) {
1014 if ($PARing eq 'p') { print STDERR "$Pgm: Can't do profiling with -parallel.\n"; exit 1; }
1015 if ($GRANing eq 'g') { print STDERR "$Pgm: Can't do profiling with -gransim.\n"; exit 1; }
1016 if ($TICKYing eq 't') { print STDERR "$Pgm: Can't do profiling with -ticky.\n"; exit 1; }
1017 $BuildTag = ($CONCURing eq 'c') ? '_mr' : '_p' ; # possibly "profiled concurrent"...
1019 } elsif ( $CONCURing eq 'c' ) {
1020 if ($PARing eq 'p') { print STDERR "$Pgm: Can't mix -concurrent with -parallel.\n"; exit 1; }
1021 if ($GRANing eq 'g') { print STDERR "$Pgm: Can't mix -concurrent with -gransim.\n"; exit 1; }
1022 $BuildTag = ($TICKYing eq 't') ? '_mt' : '_mc' ; # possibly "ticky concurrent"...
1023 # "profiled concurrent" already acct'd for...
1025 } elsif ( $PARing eq 'p' ) {
1026 if ($GRANing eq 'g') { print STDERR "$Pgm: Can't mix -parallel with -gransim.\n"; exit 1; }
1027 if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix -parallel with -ticky.\n"; exit 1; }
1030 if ( $Do_lnkr && ( ! $ENV{'PVM_ROOT'} || ! $ENV{'PVM_ARCH'} )) {
1031 print STDERR "$Pgm: both your PVM_ROOT and PVM_ARCH environment variables must be set for linking under -parallel.\n";
1035 } elsif ( $GRANing eq 'g' ) {
1036 if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix -gransim with -ticky.\n"; exit 1; }
1039 } elsif ( $TICKYing eq 't' ) {
1045 After the sanity checks, add flags to the necessary parts of the driver pipeline:
1048 if ( $BuildTag ne '' ) { # something other than normal sequential...
1050 local($Tag) = "${BuildTag}";
1051 $Tag =~ s/_//; # move the underscore to the back
1053 $HscOut = '-C='; # must go via C
1054 &processArgs(split(' ', $SetupOpts{$BuildTag}));
1055 # eval($EvaldSetupOpts{$BuildTag});
1059 Decide what the consistency-checking options are in force for this run:
1062 $HsC_consist_options = "${BuildTag},${DEBUGging}";
1063 $Cc_consist_options = "${BuildTag},${DEBUGging}";
1066 # Funny place to put it, but why not.
1068 if ( $HiSuffix_prelude eq '' ) {
1069 local($Tag) = "${BuildTag}";
1071 $Tag = "${Tag}_" if $Tag ne '';
1072 $HiSuffix_prelude="${Tag}hi";
1074 #push(@HsC_flags, "-hisuf-prelude=.${HiSuffix_prelude}"); # use appropriate Prelude .hi files
1075 #push(@HsC_flags, "-hisuf=.${HiSuffix}");
1080 %************************************************************************
1082 \subsection{Add on machine-specific C-compiler flags}
1084 %************************************************************************
1086 Shove on magical machine-specific options. We use \tr{unshift} to
1087 stick them on the {\em front} of the arrays, so that ``later''
1088 user-specified flags can clobber them (e.g., \tr{-U__STG_REV_TBLS__}).
1090 Note: a few ``always apply'' flags were set at the very beginning.
1095 if ($TargetPlatform =~ /^alpha-/) {
1096 # we know how to *mangle* asm for alpha
1097 unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1098 unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK;
1099 unshift(@CcBoth_flags, ('-static'));
1101 } elsif ($TargetPlatform =~ /^hppa/) {
1102 # we know how to *mangle* asm for hppa
1103 unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1104 unshift(@CcBoth_flags, ('-static'));
1106 # We don't put in '-mlong-calls', because it's only
1107 # needed for very big modules (sigh), and we don't want
1108 # to hobble ourselves further on all the other modules
1111 # [Dated comment (gcc-2.6.x?), -mlong-calls is no longer
1112 # a supported gcc HPPA flag]
1113 unshift(@CcBoth_flags, ('-D_HPUX_SOURCE'));
1114 # ___HPUX_SOURCE, not _HPUX_SOURCE, is #defined if -ansi!
1115 # (very nice, but too bad the HP /usr/include files don't agree.)
1117 } elsif ($TargetPlatform =~ /^i386-/) {
1118 # we know how to *mangle* asm for X86
1119 unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1120 unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK && $TargetPlatform !~ /nextstep/;
1121 # I do not know how to do STACK_CHECK_BY_PAGE_FAULT
1122 # on NeXTs (my fault, not theirs), so I don't.
1125 # -fno-defer-pop : basically the same game as for m68k
1127 # -fomit-frame-pointer : *must* ; because we're stealing
1128 # the fp (%ebp) for our register maps. *All* register
1129 # maps (in MachRegs.lh) must steal it.
1131 unshift(@CcRegd_flags_hc, '-fno-defer-pop');
1132 unshift(@CcRegd_flags, '-fomit-frame-pointer');
1133 unshift(@CcRegd_flags, "-DSTOLEN_X86_REGS=$StolenX86Regs");
1135 } elsif ($TargetPlatform =~ /^m68k-/) {
1136 # we know how to *mangle* asm for m68k
1137 unshift (@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1138 unshift (@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK && $TargetPlatform !~ /nextstep/;
1139 # I do not know how to do STACK_CHECK_BY_PAGE_FAULT
1140 # on NeXTs (my fault, not theirs), so I don't.
1143 # -fno-defer-pop : for the .hc files, we want all the pushing/
1144 # popping of args to routines to be explicit; if we let things
1145 # be deferred 'til after an STGJUMP, imminent death is certain!
1147 # -fomit-frame-pointer : *don't*
1148 # It's better to have a6 completely tied up being a frame pointer
1149 # rather than let GCC pick random things to do with it.
1150 # (If we want to steal a6, then we would try to do things
1151 # as on iX86, where we *do* steal the frame pointer [%ebp].)
1153 unshift(@CcRegd_flags_hc, '-fno-defer-pop');
1154 unshift(@CcRegd_flags, '-fno-omit-frame-pointer');
1155 # maybe gives reg alloc a better time
1156 # also: -fno-defer-pop is not sufficiently well-behaved without it
1158 } elsif ($TargetPlatform =~ /^mips-/) {
1159 # we (hope to) know how to *mangle* asm for MIPSen
1160 unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1161 unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK;
1162 unshift(@CcBoth_flags, ('-static'));
1164 } elsif ($TargetPlatform =~ /^powerpc-|^rs6000-/) {
1165 # we know how to *mangle* asm for PowerPC
1166 # :-( unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1167 unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK;
1168 unshift(@CcBoth_flags, ('-static')); # always easier to start with
1169 unshift(@CcRegd_flags, ('-finhibit-size-directive')); # avoids traceback tables
1170 } elsif ($TargetPlatform =~ /^sparc-/) {
1171 # we know how to *mangle* asm for SPARC
1172 unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1173 unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK;
1176 } # end of setupMachOpts
1179 Same unshifting magic, but for special linker flags.
1181 The configure script determines whether the object file symbol tables
1182 have a leading underscore, and sets @LeadingUnderscore@ accordingly.
1183 (The driver script `sees' the setting of the @LeadingUnderscore@
1184 by having the Makefile prepend it).
1188 local($uscore) = ( ${LeadingUnderscore} eq 'YES' ) ? '_' : '';
1191 (($Ld_main) ? ( '-u', "${uscore}Main_" . $Ld_main . '_closure' ) : ()));
1193 ( '-u', "${uscore}PrelBase_Z91Z93_closure" # i.e., []
1194 ,'-u', "${uscore}PrelBase_IZh_static_info"
1195 ,'-u', "${uscore}PrelBase_CZh_static_info"
1196 ,'-u', "${uscore}PrelBase_False_inregs_info"
1197 ,'-u', "${uscore}PrelBase_True_inregs_info"
1198 ,'-u', "${uscore}STBase_SZh_static_info"
1199 ,'-u', "${uscore}DEBUG_REGS"
1201 if ($TargetPlatform =~ /^powerpc-|^rs6000-/) {
1202 # sometimes we have lots of toc entries...
1203 # unshift(@Ld_flags, ('-Xlinker -bbigtoc -Xlinker -bnoquiet'));
1204 unshift(@Ld_flags, ('-Xlinker -bbigtoc'));
1207 } # end of setupLinkOpts
1211 %************************************************************************
1213 \subsection{Set up include paths and system-library enslurpment}
1215 %************************************************************************
1217 Now that we know what garbage-collector, etc., are required, we can
1218 finalise our list of libraries to slurp through, and generally Get
1223 # default includes must be added AFTER option processing
1224 if ( ! $INSTALLING ) {
1225 push (@Include_dir, "$TopPwd/${CURRENT_DIR}/${GHC_INCLUDE_DIR}");
1227 push (@Include_dir, "$InstLibDirGhc/includes");
1228 push (@Include_dir, "$InstLibDirGhc/includes");
1230 } # end of setupIncPaths
1235 push(@SysLibrary, ( '-lHS', '-lHS_cbits' )); # basic I/O and prelude stuff
1238 foreach $f (@SysLibrary) {
1239 next if $f =~ /_cbits/;
1240 $f .= $BuildTag if $f =~ /^-lHS/;
1243 # fiddle the TopClosure file name...
1244 $TopClosureFile =~ s/XXXX//;
1246 # Push library HSrts, plus boring clib bit
1247 push(@SysLibrary, "-lHSrts${BuildTag}");
1248 push(@SysLibrary, '-lHSclib');
1250 # RTS compiled with cygwin32, uses the WinMM API
1251 # to implement the itimers, since cygwin.dll does not
1252 # support it. Only reqd. for `ways' that use itimers.
1254 push(@SysLibrary, '-lwinmm') if $BuildTag ne '' && $TargetPlatform eq 'i386-unknown-cygwin32';
1256 # Push the pvm libraries
1257 if ($BuildTag eq '_mp') {
1258 $pvmlib = "$ENV{'PVM_ROOT'}/lib/$ENV{'PVM_ARCH'}";
1259 push(@SysLibrary, "-L$pvmlib", '-lpvm3', '-lgpvm3');
1260 if ( $ENV{'PVM_ARCH'} eq 'SUNMP' ) {
1261 push(@SysLibrary, '-lthread', '-lsocket', '-lnsl');
1262 } elsif ( $ENV{'PVM_ARCH'} eq 'SUN4SOL2' ) {
1263 push(@SysLibrary, '-lsocket', '-lnsl');
1267 # Push the GNU multi-precision arith lib; and the math library
1268 push(@SysLibrary, '-lgmp');
1269 push(@SysLibrary, '-lm');
1272 %************************************************************************
1274 \subsection{Check that this system was built to do what we are asking}
1276 %************************************************************************
1278 Before continuing we check that the appropriate build is available.
1281 #die "$Pgm: no BuildAvail?? $BuildTag\n" if $BuildDescr{$BuildTag} eq '' ; # sanity
1283 if ( $BuildDescr{$BuildTag} eq '' ) {
1284 print STDERR "$Pgm: a `", $BuildDescr{$BuildTag},
1285 "' \"build\" is not available with your GHC setup.\n";
1286 print STDERR "(It was not configured for it at your site.)\n";
1287 print STDERR $ShortUsage;
1291 } # end of setupSyslibs
1295 %************************************************************************
1297 \subsection{Final miscellaneous setup bits before we start going}
1299 %************************************************************************
1301 Record largest specific heapsize, if any.
1303 sub setupHeapStackSize {
1304 $Specific_heap_size = $Specific_heap_size * $Scale_sizes_by;
1305 push(@HsC_rts_flags, '-H'.$Specific_heap_size);
1306 $Specific_stk_size = $Specific_stk_size * $Scale_sizes_by;
1307 push(@HsC_rts_flags, "-K$Specific_stk_size");
1311 If no input or link files seen, then we let 'em feed in stdin; this is
1312 mainly for debugging.
1316 if ($#Input_file < 0 && $#Link_file < 0) {
1317 @Input_file = ( '-' );
1319 open(INF, "> $Tmp_prefix.hs") || &tidy_up_and_die(1,"Can't open $Tmp_prefix.hs\n");
1320 print STDERR "Enter your Haskell program, end with ^D (on a line of its own):\n" if -t;
1321 while (<STDIN>) { print INF $_; }
1322 close(INF) || &tidy_up_and_die(1,"Failed writing to $Tmp_prefix.hs\n");
1327 Tell the world who we are, if they asked.
1329 print STDERR "${PROJECTNAME}, version ${PROJECTVERSION}, patchlevel ${PROJECTPATCHLEVEL}\n"
1333 %************************************************************************
1335 \section[Driver-main-loop]{Main loop: Process input files, and link if required}
1337 %************************************************************************
1339 Process the input files; don't continue with linking if there are
1340 problems (global variable @$Status@ non-zero).
1342 foreach $ifile (@Input_file) {
1343 &ProcessInputFile($ifile);
1346 if ( $Status > 0 ) { # don't link if there were errors...
1347 print STDERR $ShortUsage;
1352 # append last minute flags linker and consistency flags
1359 Link if appropriate.
1362 local($libdirs) = '';
1364 # glue them together:
1365 push(@UserLibrary_dir, @SysLibrary_dir);
1367 $libdirs = '-L' . join(' -L',@UserLibrary_dir) if $#UserLibrary_dir >= 0;
1369 # for a linker, use an explicitly given one, or the going C compiler ...
1370 local($lnkr) = ( $Lnkr ) ? $Lnkr : $CcRegd;
1372 local($output) = ($Specific_output_file ne '') ? "-o $Specific_output_file" : '';
1373 @Files_to_tidy = ($Specific_output_file ne '') ? $Specific_output_file : 'a.out';
1375 local($to_do) = "$lnkr $Verbose @Ld_flags $output @Link_file $TopClosureFile $libdirs @UserLibrary @SysLibrary";
1376 &run_something($to_do, 'Linker');
1378 # finally, check the consistency info in the binary
1379 local($executable) = $Files_to_tidy[0];
1380 @Files_to_tidy = (); # reset; we don't want to nuke it if it's inconsistent
1383 # dynamically load consistency-chking code; then do it.
1384 require('ghc-consist.prl')
1385 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-consist.prl!\n");
1387 &chk_consistency_info ( $executable );
1390 # if PVM parallel stuff, we do truly weird things.
1391 # Essentially: (1) move the executable over to where PVM expects
1392 # to find it. (2) create a script in place of the executable
1393 # which will cause the program to be run, via SysMan.
1394 if ( $PARing eq 'p' ) {
1395 local($pvm_executable) = $executable;
1396 local($pvm_executable_base);
1398 if ( $pvm_executable !~ /^\// ) { # a relative path name: make absolute
1399 local($pwd) = `pwd`;
1401 $pwd =~ s/^\/tmp_mnt//;
1402 $pvm_executable = "$pwd/$pvm_executable";
1405 $pvm_executable =~ s|/|=|g; # make /s into =s
1406 $pvm_executable_base = $pvm_executable;
1408 $pvm_executable = $ENV{'PVM_ROOT'} . '/bin/' . $ENV{'PVM_ARCH'}
1409 . "/$pvm_executable";
1411 &run_something("$Rm -f $pvm_executable; $Cp -p $executable $pvm_executable && $Rm -f $executable", 'Moving binary to PVM land');
1413 # OK, now create the magic script for "$executable"
1414 open(EXEC, "> $executable") || &tidy_up_and_die(1,"$Pgm: couldn't open $executable to write!\n");
1415 print EXEC <<EOSCRIPT1;
1416 eval 'exec perl -S \$0 \${1+"\$@"}'
1417 if \$running_under_some_shell;
1418 # =!=!=!=!=!=!=!=!=!=!=!
1419 # This script is automatically generated: DO NOT EDIT!!!
1420 # Generated by Glasgow Haskell, version ${PROJECTVERSION} ${PROJECTPATCHLEVEL}
1422 \$pvm_executable = '$pvm_executable';
1423 \$pvm_executable_base = '$pvm_executable_base';
1424 \$SysMan = '$SysMan';
1427 print EXEC <<\EOSCRIPT2;
1428 # first, some magical shortcuts to run "commands" on the binary
1430 if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {
1432 system("$cmd $pvm_executable");
1436 # OK, really run it; process the args first
1437 $ENV{'PE'} = $pvm_executable_base;
1439 $nprocessors = 2; # the default
1443 # ToDo: handle --RTS
1444 args: while ($a = shift(@ARGV)) {
1445 if ( $a eq '+RTS' ) {
1447 } elsif ( $a eq '-RTS' ) {
1450 if ( $a eq '-d' && $in_RTS_args ) {
1452 } elsif ( $a =~ /^-N(\d+)/ && $in_RTS_args ) {
1455 push(@nonPVM_args, $a);
1459 local($return_val) = 0;
1460 system("$SysMan $debug $pvm_executable $nprocessors @nonPVM_args");
1462 system("mv $ENV{'HOME'}/$pvm_executable_base.???.gr .") if -f "$ENV{'HOME'}/$pvm_executable_base.001.gr";
1465 close(EXEC) || die "Failed closing $executable\n";
1466 chmod 0755, $executable;
1470 # that... that's all, folks!
1472 exit $Status; # will still be 0 if all went well
1475 %************************************************************************
1477 \section[Driver-do-one-file]{How to process a single input file}
1479 %************************************************************************
1482 sub ProcessInputFile {
1483 local($ifile) = @_; # input file name
1484 local($ifile_root); # root of or basename of input file
1485 local($ofile_target); # ultimate output file we hope to produce
1486 # from input file (need to know for recomp
1487 # checking purposes)
1488 local($hifile_target);# ditto (but .hi file)
1491 Handle the weirdity of input from stdin.
1493 if ($ifile ne '-') {
1494 ($ifile_root = $ifile) =~ s/\.[^\.\/]+$//;
1495 $ofile_target = # may be reset later...
1496 ($Specific_output_file ne '' && ! $Do_lnkr)
1497 ? $Specific_output_file
1498 : &odir_ify($ifile_root, 'o');
1499 $hifile_target= ($Specific_hi_file ne '')
1501 : "$ifile_root.$HiSuffix"; # ToDo: odirify?
1502 # NB: may change if $ifile_root isn't module name (??)
1504 $ifile = "$Tmp_prefix.hs"; # we know that's where we put the input
1505 $ifile_root = '_stdin';
1506 $ofile_target = '_stdout'; # gratuitous?
1507 $hifile_target= '_stdout'; # ditto?
1511 We need to decide what phases of the compilation system we will run
1512 over this file. The defaults are the ones established when processing
1513 flags. (That established what the last phase run for all files is.)
1515 We do the pre-recompilation-checker phases here; the rest later.
1519 Look at the suffix and decide what initial phases of compilation may
1520 be dropped off for this file. Also the rather boring business of
1521 which files are coming-in/going-out.
1523 Again, we'll do the post-recompilation-checker parts of this later.
1525 local($do_lit2pgm) = ($ifile =~ /\.lhs$/) ? 1 : 0;
1526 local($do_hscpp) = 1; # but "hscpp" might really be "cat"
1529 # names of the files to stuff between phases
1530 # defaults are temporaries
1531 local($in_lit2pgm) = $ifile;
1532 local($lit2pgm_hscpp) = "$Tmp_prefix.lpp";
1533 local($hscpp_hsc) = "$Tmp_prefix.cpp";
1534 local($hsc_hi) = "$Tmp_prefix.hi";
1535 local($cc_as_o) = "${Tmp_prefix}_o.s"; # temporary for raw .s file if opt C
1536 local($cc_as) = "$Tmp_prefix.s"; # mangled or hsc-produced .s code
1537 local($as_out) = $ofile_target;
1539 local($is_hc_file) = 1; #Is the C code .hc or .c? Assume .hc for now
1541 # OK, let's strip off some literate junk..
1543 &runLit2pgm($in_lit2pgm, $lit2pgm_hscpp)
1545 $lit2pgm_hscpp = $ifile;
1551 # Scan the top of the de-litted file for {-# OPTIONS #-} pragmas
1552 &check_for_source_options($lit2pgm_hscpp,$ifile);
1554 # Options found in the source file take a back seat, i.e., we scan
1555 # them first. Only process the command line again if source file
1556 # contained anything of interest *or* there's more than one
1557 # input file (we have to reset the options).
1559 if ( $#Input_file >= 0 || $#File_options >= 0) {
1560 #@File_options = (@File_options, @Cmd_opts);
1562 # Now process the command line
1563 &initDriverGlobals();
1564 &processArgs((@File_options,@Cmd_opts));
1565 print STDERR "\nEffective command line: " .
1566 join(' ',(@File_options,@Cmd_opts)) . "\n" if $Verbose;
1569 # Having got the effective command line scanned, set up
1570 # the various options in prep for some real work.
1572 # check the sanity of the BuildTag we're about to use,
1573 # and if needs be, add some more flags and setup to
1574 # the different phases.
1577 &setupOptimiseFlags();
1580 &setupHeapStackSize();
1583 # These two variables need to be set after the
1584 # command-line has been processed and the build options
1585 # have be seen set up. This is because command-line options
1586 # can control whether to compile vias C or not.
1588 local($do_cc) = ( $Do_cc != -1) # i.e., it was set explicitly
1590 : ( ($HscOut eq '-C=') ? 1 : 0 );
1591 local($do_as) = $Do_as;
1592 local($hsc_out) = ( $HscOut eq '-C=' ) ? "$Tmp_prefix.hc" : "$Tmp_prefix.s" ;
1594 if ($Only_preprocess_hc) { # stop after having run $Cc -E
1597 if ($Only_preprocess_C) { # stop after having run $hscpp
1598 $do_hsc=0; $do_cc = 0; $do_as=0;
1599 } elsif ($ifile =~ /.lhs$/ || $ifile =~ /.hs$/ ) {
1601 } elsif ($ifile =~ /\.hc$/ || $ifile =~ /_hc$/ ) { # || $ifile =~ /\.$Isuffix$/o) # ToDo: better
1602 $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
1604 } elsif ($ifile =~ /\.c$/) {
1605 $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
1606 $hsc_out = $ifile; $is_hc_file = 0;
1607 } elsif ($ifile =~ /\.s$/) {
1608 $do_hscpp = 0; $do_hsc = 0; $do_cc = 0;
1610 } else { # don't know what it is, but nothing to do herein...
1611 $do_hscpp = 0; $do_hsc = 0; $do_cc = 0; $do_as = 0;
1614 # hack to avoid running hscpp
1615 $HsCpp = $Cat if ! $Cpp_flag_set;
1617 &runHscpp($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc) if $do_hscpp;
1621 We now think about whether to run hsc/cc or not (when hsc produces .s
1622 stuff, it effectively takes the place of both phases).
1624 To get the output file name right: for each phase that we are {\em
1625 not} going to run, set its input (i.e., the output of its preceding
1626 phase) to @"$ifile_root.<suffix>"@.
1629 local($going_interactive) = $HscOut eq '-N=' || $ifile_root eq '_stdin';
1632 # Warning issued if -keep-hc-file-too is used without
1633 # -fvia-C (or the equivalent)
1635 if ( $HscOut ne '-C=' && $Keep_hc_file_too ) {
1636 print STDERR "$Pgm: warning: Native code generator to be used, -keep-hc-file-too will be ignored\n";
1639 if (! $do_cc && ! $do_as) { # stopping after hsc
1640 $hsc_out = ($Specific_output_file ne '')
1641 ? $Specific_output_file
1642 : &odir_ify($ifile_root, ($HscOut eq '-C=') ? 'hc' : 's');
1644 $ofile_target = $hsc_out; # reset
1647 if (! $do_as) { # stopping after gcc (or hsc)
1648 $cc_as = ($Specific_output_file ne '')
1649 ? $Specific_output_file
1650 : &odir_ify($ifile_root, ( $Only_preprocess_hc ) ? 'i' : 's');
1652 $ofile_target = $cc_as; # reset
1658 Now the Haskell compiler, C compiler, and assembler
1662 &runHscAndProcessInterfaces( $ifile, $hscpp_hsc, $ifile_root,
1663 $ofile_target, $hifile_target);
1667 &runGcc ($is_hc_file, $hsc_out, $cc_as_o);
1668 &runMangler($is_hc_file, $cc_as_o, $cc_as, $ifile_root) if ! $Only_preprocess_hc;
1671 &split_asm_file($cc_as) if $do_as && $SplitObjFiles;
1673 # save a copy of the .s file..
1674 &saveIntermediate($ifile_root , "s" , $cc_as) if ($do_as && $Keep_s_file_too);
1675 &runAs($as_out, $ifile_root) if $do_as;
1678 Finally, decide what to queue up for linker input.
1680 # tentatively assume we will eventually produce linker input:
1681 push(@Link_file, &odir_ify($ifile_root, 'o'));
1683 #ToDo: local($or_isuf) = ($Isuffix eq '') ? '' : "|$Isuffix";
1685 if ( $ifile !~ /\.(lhs|hs|hc|c|s)$/ && $ifile !~ /_hc$/ ) {
1686 print STDERR "$Pgm: don't recognise suffix on `$ifile'; passing it through to linker\n"
1687 if $ifile !~ /\.a$/;
1689 # oops; we tentatively pushed the wrong thing; fix & do the right thing
1690 pop(@Link_file); push(@Link_file, $ifile);
1694 } # end of ProcessInputFile
1697 %************************************************************************
1699 \section[Driver-run-phases]{Routines to run the various phases}
1701 %************************************************************************
1705 local($in_lit2pgm, $lit2pgm_hscpp) = @_;
1709 # Only add #line pragma if we're going to need it.
1710 $to_do = "echo '#line 1 \"$in_lit2pgm\"' > $lit2pgm_hscpp && " if ($Cpp_flag_set);
1711 $to_do .= "$Unlit @Unlit_flags $in_lit2pgm - >> $lit2pgm_hscpp";
1713 push(@Files_to_tidy, $lit2pgm_hscpp );
1715 &run_something($to_do, 'literate pre-processor');
1721 local($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc) = @_;
1725 # Strictly speaking, echoing of the following line pragma is only required
1726 # on non-delit'ed input, as we've already added it during de-lit. However,
1727 # hscpp will then add a {-# LINE 1 "$lit2pgm_hsc" -} to the top of the file,
1728 # which is not very informative (but harmless). Hence, we uniformly have
1729 # {-# LINE 1 "$in_lit2pgm" #-} as the first line to all cpp'ed hsc input.
1731 $to_do = "echo '{-# LINE 1 \"$in_lit2pgm\" -}' > $hscpp_hsc && ";
1733 if ($HsCpp eq $Cat) {
1734 $to_do .= "$HsCpp $lit2pgm_hscpp >> $hscpp_hsc";
1735 push(@Files_to_tidy, $hscpp_hsc );
1736 &run_something($to_do, 'Ineffective C pre-processor');
1738 local($includes) = '-I' . join(' -I',@Include_dir);
1739 $to_do .= "$HsCpp $Verbose $genSPECS_flag @HsCpp_flags -D__HASKELL1__=$Haskell1Version -D__GLASGOW_HASKELL__=$GhcVersionInfo $includes $lit2pgm_hscpp >> $hscpp_hsc";
1740 push(@Files_to_tidy, $hscpp_hsc );
1741 &run_something($to_do, 'Haskellised C pre-processor');
1744 if ( $Only_preprocess_C ) {
1745 $to_do = "$Cat $hscpp_hsc";
1746 &run_something($to_do, '');
1754 sub runHscAndProcessInterfaces {
1755 local($ifile, $hscpp_hsc, $ifile_root, $ofile_target, $hifile_target) = @_;
1757 # $ifile is the original input file
1758 # $hscpp_hsc post-unlit, post-cpp, etc., input file
1759 # $ifile_root input filename minus suffix
1760 # $ofile_target the output file that we ultimately hope to produce
1761 # $hifile_target the .hi file ... (ditto)
1763 local($source_unchanged) = 1;
1765 # Check if the source file is up to date relative to the target; in
1766 # that case we say "source is unchanged" and let the compiler bail out
1767 # early if the import usage information allows it.
1769 ($i_dev,$i_ino,$i_mode,$i_nlink,$i_uid,$i_gid,$i_rdev,$i_size,
1770 $i_atime,$i_mtime,$i_ctime,$i_blksize,$i_blocks) = stat($ifile);
1772 # The informational messages below are now conditional on -v being set -- SOF
1773 if ( $ofile_target ne "_stdin.s" && ! -f $ofile_target ) {
1774 print STDERR "$Pgm:compile:Output file $ofile_target doesn't exist\n" if $Verbose;
1775 $source_unchanged = 0;
1778 ($o_dev,$o_ino,$o_mode,$o_nlink,$o_uid,$o_gid,$o_rdev,$o_size,
1779 $o_atime,$o_mtime,$o_ctime,$o_blksize,$o_blocks) = stat(_); # stat info from -f test
1781 if ( $hifile_target ne "_stdout" && ! -f $hifile_target ) {
1782 print STDERR "$Pgm:compile:Interface file $hifile_target doesn't exist\n" if $Verbose;
1783 $source_unchanged = 0;
1786 ($hi_dev,$hi_ino,$hi_mode,$hi_nlink,$hi_uid,$hi_gid,$hi_rdev,$hi_size,
1787 $hi_atime,$hi_mtime,$hi_ctime,$hi_blksize,$hi_blocks) = stat(_); # stat info from -f test
1789 if ( $ofile_target ne "_stdin.s" && $i_mtime > $o_mtime) {
1790 print STDERR "$Pgm:recompile:Input file $ifile newer than $ofile_target\n" if $Verbose;
1791 $source_unchanged = 0;
1794 # So if source_unchanged is still "1", we pass on the good news to the compiler
1795 # The -recomp flag can disable this, forcing recompilation
1796 if ($Do_recomp_chkr && $source_unchanged) {
1797 push(@HsC_flags, '-fsource-unchanged');
1802 &runHsc($ifile_root, $hsc_out, $hsc_hi, $going_interactive);
1804 # See if it bailed out early, saying nothing needed doing.
1805 # We work this out by seeing if it created an output .hi file
1807 if ( ! -f $hsc_hi && $ProduceHi !~ /-nohifile=/ ) {
1808 # Doesn't exist, so we bailed out early.
1809 # Tell the C compiler and assembler not to run
1810 $do_cc = 0; $do_as = 0;
1812 # Update dependency info, touch both object file and
1813 # interface file, so that the following invariant is
1816 # a dependent module's interface file should after recompilation
1817 # checking be newer than the interface files of its imports.
1819 # That is, if module A's interface file changes, then module B
1820 # (which import from A) needs to be checked.
1821 # If A's change does not affect B, which causes the compiler to bail
1822 # out early, we still need to touch the interface file of B. The reason
1823 # for this is that B may export A's interface.
1825 &run_something("touch $ofile_target",
1826 "Touch $ofile_target, to propagate dependencies") if $HscOut ne '-N=';
1827 &run_something("touch $hifile_target",
1828 "Touch $hifile_target, to propagate dependencies") if $ProduceHi =~ /-nohifile=/ ;
1832 # Didn't bail out early (new .hi file) so we thunder on
1834 # If non-interactive, heave in the consistency info at the end
1835 # NB: pretty hackish (depends on how $output is set)
1836 if ( ! $going_interactive ) {
1837 if ( $HscOut eq '-C=' ) {
1838 $to_do = "echo 'static char ghc_hsc_ID[] = \"\@(#)hsc $ifile\t$HsC_major_version.$HsC_minor_version,$HsC_consist_options\";' >> $hsc_out";
1840 } elsif ( $HscOut eq '-S=' ) {
1841 local($consist) = "hsc.$ifile.$HsC_major_version.$HsC_minor_version.$HsC_consist_options";
1842 $consist =~ s/,/./g;
1843 $consist =~ s/\//./g;
1844 $consist =~ s/-/_/g;
1845 $consist =~ s/[^A-Za-z0-9_.]/ZZ/g; # ToDo: properly?
1846 $to_do = "echo '\n\t.text\n$consist:' >> $hsc_out";
1848 &run_something($to_do, 'Pin on Haskell consistency info');
1852 # Interface-handling is important enough to live off by itself
1853 if ( $ProduceHi !~ /-nohifile=/ ) { # If we've produced one, process it.
1854 require('ghc-iface.prl') || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-iface.prl!\n");
1855 &postprocessHiFile($hsc_hi, $hifile_target, $going_interactive);
1857 # if we're going to split up object files,
1858 # we inject split markers into the .hc file now
1859 if ( $HscOut eq '-C=' && $SplitObjFiles ) {
1860 &inject_split_markers ( $hsc_out );
1863 # save a copy of the .hc file, even if we are carrying on...
1864 if ($HscOut eq '-C=' && $do_cc && $Keep_hc_file_too) {
1865 &saveIntermediate($ifile_root , "hc" , $hsc_out);
1875 local($ifile_root, $hsc_out, $hsc_hi, $going_interactive) = @_;
1877 # prepend comma to HsP flags (so hsc can tell them apart...)
1878 foreach $a ( @HsP_flags ) { $a = ",$a" unless $a =~ /^,/; }
1880 &makeHiMap() unless $HiMapDone;
1881 #print STDERR "HiIncludes: $HiIncludeString\n";
1882 push(@HsC_flags, "-himap=$HiIncludeString");
1884 # here, we may produce .hc/.s and/or .hi files
1885 local($output) = '';
1886 #@Files_to_tidy = ();
1888 if ( $going_interactive ) {
1889 # don't need .hi unless going to show it on stdout:
1890 $ProduceHi = '-nohifile=' if ! $HiOnStdout;
1891 $do_cc = 0; $do_as = 0; $Do_lnkr = 0; # and we won't go any further...
1894 # set up for producing output/.hi; note that flag twiddling
1895 # may mean that nothing will actually be produced:
1896 $output = "$ProduceHi$hsc_hi $HscOut$hsc_out";
1897 push(@Files_to_tidy, $hsc_hi, $hsc_out );
1899 # if we're compiling foo.hs, we want the GC stats to end up in foo.stat
1900 if ( $CollectingGCstats ) {
1901 push(@HsC_rts_flags, "-S$ifile_root.stat");
1902 push(@Files_to_tidy, "$ifile_root.stat");
1905 if ( $CollectGhcTimings ) { # assume $RTS_style eq 'ghc'
1906 # emit nofibbish time/bytes-alloc stats to stderr;
1907 # see later .stat file post-processing
1908 print STDERR "warning: both -Rgc-stats and -Rghc-timing used, -Rghc-timing wins." if $CollectingGCstats;
1909 push(@HsC_rts_flags, "-s$Tmp_prefix.stat");
1910 push(@Files_to_tidy, "$Tmp_prefix.stat");
1914 if ($Specific_dump_file ne '') {
1915 $dump = "2>> $Specific_dump_file";
1916 $Using_dump_file = 1;
1920 $to_do = "$HsC @HsP_flags ,$hscpp_hsc $dump @HsC_flags $CoreLint $StgLint $Verbose $output +RTS @HsC_rts_flags";
1921 &run_something($to_do, 'Haskell compiler');
1923 # finish business w/ nofibbish time/bytes-alloc stats
1924 &process_ghc_timings() if $CollectGhcTimings;
1928 Use \tr{@Import_dir} and \tr{@SysImport_dir} to make a tmp file
1929 of (module-name, pathname) pairs, one per line, separated by a space.
1932 $HiIncludeString = (); # dir1:dir2:dir3, to pass to GHC
1936 # collect in %HiMap; write later; also used elsewhere in driver
1938 local($mod, $path, $d, $e);
1940 # reset the global variables:
1942 $HiIncludeString = (); # dir1:dir2:dir3, to pass to GHC
1944 foreach $d ( @Import_dir ) {
1945 if ($HiIncludeString) {
1946 $HiIncludeString = "$HiIncludeString:${d}%.${HiSuffix}";
1948 $HiIncludeString = "$d%.${HiSuffix}";
1953 foreach $d ( @SysImport_dir ) {
1954 if ($HiIncludeString) {
1955 $HiIncludeString = "$HiIncludeString:${d}%.${HiSuffix_prelude}";
1957 $HiIncludeString = "${d}%.${HiSuffix_prelude}";
1966 %************************************************************************
1968 \section[Driver-misc-utils]{Miscellaneous utilities}
1970 %************************************************************************
1972 %************************************************************************
1974 \subsection[Driver-odir-ify]{@odir_ify@: Mangle filename if \tr{-odir} set}
1976 %************************************************************************
1980 local($ofile,$def_suffix) = @_;
1982 return(($Osuffix eq '') ? "$ofile.$def_suffix" : "$ofile.$Osuffix" );
1986 local($orig_file, $def_suffix) = @_;
1987 if ($Specific_output_dir eq '') { # do nothing
1988 &osuf_ify($orig_file, $def_suffix);
1990 local ($orig_file_only);
1991 ($orig_file_only = $orig_file) =~ s|.*/||;
1992 &osuf_ify("$Specific_output_dir/$orig_file_only",$def_suffix);
1999 local($is_hc_file, $hsc_out, $cc_as_o) = @_;
2001 local($includes) = '-I' . join(' -I', @Include_dir);
2004 local($c_flags) = "@CcBoth_flags";
2005 local($ddebug_flag) = ( $DEBUGging ) ? '-DDEBUG' : '';
2007 # "input" files to use that are not in some weird directory;
2008 # to help C compilers grok .hc files [ToDo: de-hackify]
2009 local($cc_help) = "ghc$$.c";
2010 local($cc_help_s) = "ghc$$.s";
2013 $s_output = ($is_hc_file || $TargetPlatform =~ /^(powerpc|rs6000|hppa|i386)/) ? $cc_as_o : $cc_as;
2014 $c_flags .= " @CcRegd_flags";
2015 $c_flags .= ($is_hc_file) ? " @CcRegd_flags_hc" : " @CcRegd_flags_c";
2017 # C compiler won't like the .hc extension. So we create
2018 # a tmp .c file which #include's the needful.
2019 open(TMP, "> $cc_help") || &tidy_up_and_die(1,"$Pgm: failed to open `$cc_help' (to write)\n");
2020 if ( $is_hc_file ) {
2022 #ifdef __STG_GCC_REGS__
2023 # if ! (defined(MAIN_REG_MAP) || defined(MARK_REG_MAP) || defined(SCAN_REG_MAP) || defined(SCAV_REG_MAP) || defined(FLUSH_REG_MAP))
2024 # define MAIN_REG_MAP
2027 #include "stgdefs.h"
2029 # user may have asked for #includes to be injected...
2030 print TMP @CcInjects if $#CcInjects >= 0;
2032 # heave in the consistency info
2033 print TMP "static char ghc_cc_ID[] = \"\@(#)cc $ifile\t$Cc_major_version.$Cc_minor_version,$Cc_consist_options\";\n";
2035 # and #include the real source
2036 print TMP "#include \"$hsc_out\"\n";
2037 close(TMP) || &tidy_up_and_die(1,"Failed writing to $cc_help\n");
2039 # Don't redirect stderr into intermediate file if slamming output onto stdout (e.g., with -E)
2040 local($fuse_stderr) = "2>&1" if ! $Only_preprocess_hc;
2041 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 )";
2042 # note: __GLASGOW_HASKELL__ is pointedly *not* #defined at the C level.
2044 if ( $Only_preprocess_hc ) { # HACK ALERT!
2045 $to_do =~ s/ -S\b//g;
2047 push(@Files_to_tidy, $cc_help, $cc_help_s, $s_output );
2048 $PostprocessCcOutput = 1 if ! $Only_preprocess_hc; # hack, dear hack...
2049 &run_something($to_do, 'C compiler');
2050 $PostprocessCcOutput = 0;
2051 if ( $Only_preprocess_hc ) {
2052 system("$Cat $Tmp_prefix.ccout");
2054 unlink($cc_help, $cc_help_s);
2060 local($is_hc_file, $cc_as_o, $cc_as, $ifile_root) = @_;
2062 if ( $is_hc_file ) {
2063 # dynamically load assembler-fiddling code, which we are about to use:
2064 require('ghc-asm.prl')
2065 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm.prl!\n");
2068 print STDERR `cat $cc_as_o` if $Dump_raw_asm; # to stderr, before mangling
2071 # post-process the assembler [.hc files only]
2072 &mangle_asm($cc_as_o, $cc_as);
2076 #OLD: local($target) = 'oops';
2077 #OLD: $target = '-alpha' if $TargetPlatform =~ /^alpha-/;
2078 #OLD: $target = '-hppa' if $TargetPlatform =~ /^hppa/;
2079 #OLD: $target = '-old-asm' if $TargetPlatform =~ /^i386-/;
2080 #OLD: $target = '-m68k' if $TargetPlatform =~ /^m68k-/;
2081 #OLD: $target = '-mips' if $TargetPlatform =~ /^mips-/;
2082 #OLD: $target = '' if $TargetPlatform =~ /^powerpc-/;
2083 #OLD: $target = '-solaris' if $TargetPlatform =~ /^sparc-sun-solaris2/;
2084 #OLD: $target = '-sparc' if $TargetPlatform =~ /^sparc-sun-sunos4/;
2086 #OLD: if ( $target ne '' ) {
2087 #OLD: require("ghc-asm$target.prl")
2088 #OLD: || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm$target.prl!\n");
2089 #OLD: &mangle_asm($cc_as_o, "$cc_as-2"); # the OLD one!
2090 #OLD: &run_something("$Cmp -s $cc_as-2 $cc_as || $Diff $cc_as-2 $cc_as 1>&2 || exit 0",
2091 #OLD: "Diff'ing old and new mangled .s files"); # NB: to stderr
2094 } elsif ($TargetPlatform =~ /^hppa/) {
2095 # minor mangling of non-threaded files for hp-pa only
2096 require('ghc-asm.prl')
2097 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-hppa.prl!\n");
2098 &mini_mangle_asm_hppa($cc_as_o, $cc_as);
2100 } elsif ($TargetPlatform =~ /^powerpc|^rs6000/) {
2101 # minor mangling of non-threaded files for powerpcs and rs6000s
2102 require('ghc-asm.prl')
2103 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-powerpc.prl!\n");
2104 &mini_mangle_asm_powerpc($cc_as_o, $cc_as);
2105 } elsif ($TargetPlatform =~ /^i386/) {
2106 # extremely-minor OFFENSIVE mangling of non-threaded just one file
2107 require('ghc-asm.prl')
2108 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm.prl!\n");
2109 &mini_mangle_asm_i386($cc_as_o, $cc_as);
2112 # save a copy of the .s file, even if we are carrying on...
2113 #if ($do_as && $Keep_s_file_too) {
2114 # &saveIntermediate($ifile_root , "s" , $cc_as);
2121 local($as_out, $ifile_root) = @_;
2123 local($asmblr) = ( $As ) ? $As : $CcRegd;
2125 if ( ! $SplitObjFiles ) {
2126 local($to_do) = "$asmblr -o $as_out -c @As_flags $cc_as";
2127 push(@Files_to_tidy, $as_out );
2128 &run_something($to_do, 'Unix assembler');
2130 } else { # more complicated split-ification...
2132 # must assemble files $Tmp_prefix__[1 .. $NoOfSplitFiles].s
2134 # If -odir is used, great, just pin it in front of the
2135 # generated split file names. If it hasn't been set, we
2136 # snatch it from the ifile_root.
2140 if ( $Specific_output_dir eq '' ) {
2141 $Specific_output_dir = ${ifile_root};
2144 for ($f = 1; $f <= $NoOfSplitFiles; $f++ ) {
2145 local($split_out) = &odir_ify("${ifile_root}__${f}",'o');
2146 local($to_do) = "$asmblr -o $split_out -c @As_flags ${Tmp_prefix}__${f}.s";
2147 push(@Files_to_tidy, $split_out );
2149 &run_something($to_do, 'Unix assembler');
2155 %************************************************************************
2157 \subsection[Driver-run-something]{@run_something@: Run a phase}
2159 %************************************************************************
2163 local($str_to_do, $tidy_name) = @_;
2165 print STDERR "\n$tidy_name:\n\t" if $Verbose;
2166 print STDERR "$str_to_do\n" if $Verbose;
2168 if ($Using_dump_file) {
2169 open(DUMP, ">> $Specific_dump_file")
2170 || &tidy_up_and_die(1,"$Pgm: failed to open `$Specific_dump_file'\n");
2171 print DUMP "\nCompilation Dump for: $str_to_do\n\n";
2173 || &tidy_up_and_die(1,"$Pgm: failed closing `$Specific_dump_file'\n");
2176 local($return_val) = 0;
2178 if ( length($str_to_do) > 4000) {
2179 # 4000 - on the random side, just like the *real* ARG_MAX
2182 # With some shells, command lines of this length may
2183 # very well cause trouble. To safeguard against this, we squirrel the
2184 # command into a file and exec that.
2185 local ($sh) = $ENV{'REAL_SHELL'};
2186 print STDERR "Backup plan A: saving cmd line in ${Tmp_prefix}.sh and executing that with $sh\n" if $Verbose;
2187 open (TEMP, "> ${Tmp_prefix}.sh") ||
2188 &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.sh'\n");
2189 print TEMP "$Time $str_to_do\n";
2191 &tidy_up_and_die(1,"$Pgm: failed closing `$Tmp_prefix.sh'\n");
2192 system("$sh $Tmp_prefix.sh");
2195 unlink "${Tmp_prefix}.sh";
2197 system("$Time $str_to_do");
2201 if ( $PostprocessCcOutput ) { # hack, continued
2202 open(CCOUT, "< $Tmp_prefix.ccout")
2203 || &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.ccout'\n");
2205 next if /attribute directive ignored/;
2206 next if /call-clobbered/;
2207 next if /from .*COptRegs\.lh/;
2208 next if /from .*(stg|rts)defs\.h:/;
2209 next if /from ghc\d+.c:\d+:/;
2210 next if /from .*\.lc/;
2211 next if /from .*SMinternal\.l?h/;
2212 next if /ANSI C does not support \`long long\'/;
2213 next if /warning:.*was declared \`extern\' and later \`static\'/;
2214 next if /warning: assignment discards \`const\' from pointer target type/;
2215 next if /: At top level:$/;
2216 next if /: In function \`.*\':$/;
2217 next if /\`ghc_cc_ID\' defined but not used/;
2220 close(CCOUT) || &tidy_up_and_die(1,"$Pgm: failed closing `$Tmp_prefix.ccout'\n");
2223 if ($return_val != 0) {
2224 if ($Using_dump_file) {
2225 print STDERR "Compilation Errors dumped in $Specific_dump_file\n";
2228 &tidy_up_and_die($return_val, '');
2230 $Using_dump_file = 0;
2234 %************************************************************************
2236 \subsection[Driver-ghc-timing]{Emit nofibbish GHC timings}
2238 %************************************************************************
2240 NB: nearly the same as in @runstdtest@ script.
2243 sub process_ghc_timings {
2244 local($StatsFile) = "$Tmp_prefix.stat";
2245 local($SysSpecificTiming) = 'ghc';
2247 open(STATS, $StatsFile) || die "Failed when opening $StatsFile\n";
2248 local($max_live) = 0;
2249 local($tot_live) = 0; # for calculating residency stuff
2250 local($tot_samples) = 0;
2253 if (! /Minor/ && /^\s*\d+\s+\d+\s+(\d+)\s+\d+\.\d+\%/ ) {
2254 $max_live = $1 if $max_live < $1;
2258 $BytesAlloc = $1 if /^\s*([0-9,]+) bytes allocated in the heap/;
2260 if ( /^\s*([0-9,]+) bytes maximum residency .* (\d+) sample/ ) {
2261 $MaxResidency = $1; $ResidencySamples = $2;
2264 $GCs = $1 if /^\s*([0-9,]+) garbage collections? performed/;
2266 # The presence of -? in the following pattern is only there to
2267 # accommodate 0.29 && <= 2.05 RTS'
2268 if ( /^\s*INIT\s+time\s*(\d+\.\d\d)s\s*\(\s*-?(\d+\.\d\d)s elapsed\)/ ) {
2269 $InitTime = $1; $InitElapsed = $2;
2270 } elsif ( /^\s*MUT\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2271 $MutTime = $1; $MutElapsed = $2;
2272 } elsif ( /^\s*GC\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2273 $GcTime = $1; $GcElapsed = $2;
2276 close(STATS) || die "Failed when closing $StatsFile\n";
2277 if ( $tot_samples > 0 ) {
2278 $ResidencySamples = $tot_samples;
2279 $MaxResidency = $max_live;
2280 $AvgResidency = int ($tot_live / $tot_samples) ;
2283 # warn about what we didn't find
2284 print STDERR "Warning: BytesAlloc not found in stats file\n" unless defined($BytesAlloc);
2285 print STDERR "Warning: GCs not found in stats file\n" unless defined($GCs);
2286 print STDERR "Warning: InitTime not found in stats file\n" unless defined($InitTime);
2287 print STDERR "Warning: InitElapsed not found in stats file\n" unless defined($InitElapsed);
2288 print STDERR "Warning: MutTime not found in stats file\n" unless defined($MutTime);
2289 print STDERR "Warning: MutElapsed not found in stats file\n" unless defined($MutElapsed);
2290 print STDERR "Warning: GcTime inot found in stats file\n" unless defined($GcTime);
2291 print STDERR "Warning: GcElapsed not found in stats file\n" unless defined($GcElapsed);
2293 # things we didn't necessarily expect to find
2294 $MaxResidency = 0 unless defined($MaxResidency);
2295 $AvgResidency = 0 unless defined($AvgResidency);
2296 $ResidencySamples = 0 unless defined($ResidencySamples);
2299 $BytesAlloc =~ s/,//g;
2300 $MaxResidency =~ s/,//g;
2302 $InitTime =~ s/,//g;
2303 $InitElapsed =~ s/,//g;
2305 $MutElapsed =~ s/,//g;
2307 $GcElapsed =~ s/,//g;
2309 # print out what we found
2310 print STDERR "<<$SysSpecificTiming: ",
2311 "$BytesAlloc bytes, $GCs GCs, $AvgResidency/$MaxResidency avg/max bytes residency ($ResidencySamples samples), $InitTime INIT ($InitElapsed elapsed), $MutTime MUT ($MutElapsed elapsed), $GcTime GC ($GcElapsed elapsed)",
2312 " :$SysSpecificTiming>>\n";
2319 %************************************************************************
2321 \subsection[Driver-dying]{@tidy_up@ and @tidy_up_and_die@: Dying gracefully}
2323 %************************************************************************
2327 local($to_do) = "\n$Rm $Tmp_prefix*";
2328 if ( $Tmp_prefix !~ /^\s*$/ ) {
2329 print STDERR "$to_do\n" if $Verbose;
2334 sub tidy_up_and_die {
2335 local($return_val, $msg) = @_;
2337 # delete any files to tidy
2338 print STDERR "deleting... @Files_to_tidy\n" if $Verbose && $#Files_to_tidy >= 0;
2339 unlink @Files_to_tidy if $#Files_to_tidy >= 0;
2343 exit (($return_val == 0) ? 0 : 1);
2347 %************************************************************************
2349 \subsection[Driver-arg-with-arg]{@grab_arg_arg@: Do an argument with an argument}
2351 %************************************************************************
2353 Some command-line arguments take an argument, e.g.,
2354 \tr{-Rmax-heapsize} expects a number to follow. This can either be
2355 given a part of the same argument (\tr{-Rmax-heapsize8M}) or as the
2356 next argument (\tr{-Rmax-heapsize 8M}). We allow both cases.
2358 Note: no error-checking; \tr{-Rmax-heapsize -Rgc-stats} will silently
2359 gobble the second argument (and probably set the heapsize to something
2363 local(*Args, $option, $rest_of_arg) = @_;
2365 if ($rest_of_arg ne '') {
2366 return($rest_of_arg);
2367 } elsif ($#Args >= 0) {
2368 local($temp) = $Args[0]; shift(@Args);
2371 print STDERR "$Pgm: no argument following $option option\n";
2382 #Not in HsC_antiflag ## NO!: and not already in HsC_flags
2384 foreach $f ( @HsC_antiflags ) {
2385 return(0) if $flag eq $f;
2387 # foreach $f ( @HsC_flags ) {
2388 # return(0) if $flag eq $f;
2393 sub squashHscFlag { # pretty terrible
2397 foreach $f ( @HsC_flags ) {
2398 if ($flag eq $f) { $f = ''; }
2406 foreach $f ( @flags ) {
2407 push( @HsC_flags, $f ) if &isntAntiFlag($f);
2412 Source files may have {-# OPTIONS ... #-} pragmas at the top, containing
2413 command line options we want to append to collection of commands specified
2414 directly. @check_for_source_options@ looks at the top of a de-lit'ified Haskell
2415 file for any such pragmas:
2418 sub check_for_source_options {
2419 local($file,$ifile) = @_;
2420 local($comment_start,$comment_end);
2422 if ($ifile =~ /\.hc$/ ||
2425 $ifile =~ /_s$/ ) { # `Real' C intermediate
2426 $comment_start = "/\\*";
2427 $comment_end = "\\*/";
2428 } else { # Assume it is a file containing Haskell source
2429 $comment_start = "{-#";
2430 $comment_end = "#-}";
2433 open(FILE,$file) || return(1); # No big loss
2436 if ( /^${comment_start} OPTIONS (.*)${comment_end}$/ ) {
2437 # add the options found at the back of the command line.
2438 local(@entries) = split(/\s+/,$1);
2439 print STDERR "Found OPTIONS " . join(' ',@entries) . " in $file\n" if $Verbose;
2440 push(@File_options, @entries);
2442 elsif ( /^$/ ) { # ignore empty lines
2445 elsif ( /^#line.+$/ ) { # ignore comment lines (unused..ToDo: rm )
2448 elsif ( /^{-# LINE.+$/ ) { # ignore line pragmas
2451 else { # stop looking, something non-empty / not
2452 # ${comment_start} OPTIONS .. ${comment_end} encountered.
2453 close(FILE);return(0);
2462 We split the initial argv up into three arrays:
2468 the reason for doing so is to be able to deal
2469 with {-# OPTIONS #-} pragma in source files properly.
2475 arg: while($_ = $args[0]) {
2477 # sigh, we have to deal with these -option arg specially here.
2478 /^-(tmpdir|odir|ohi|o|isuf|osuf|hisuf|hisuf-prelude|odump|syslib)$/ &&
2479 do { push(@Cmd_opts, $_); push(@Cmd_opts,$args[0]); shift(@args); next arg; };
2480 /^--?./ && do { push(@Cmd_opts, $_); next arg; };
2482 if (/\.([^_]+_)?[oa]$/) {
2483 push(@Link_file, $_);
2485 push(@Input_file, $_);
2488 # input files must exist:
2490 print STDERR "$Pgm: input file doesn't exist: $_\n";
2498 When saving an intermediate file (.hc or .s) away, we
2499 have to prefix any OPTIONS found in the original source file.
2502 sub saveIntermediate {
2503 local ($final,$suffix,$tmp)= @_ ;
2506 # $final -- root of where to park ${final}.${suffix}
2507 # $tmp -- temporary file where hsc put the intermediate file.
2509 # Delete the old file
2510 $to_do = "$Rm ${final}.${suffix}"; &run_something($to_do, "Removing old .${suffix} file");
2512 if ( $#File_options >= 0 ) { # OPTIONS found in Haskell source unit
2513 # Add OPTION comment to the top of the generated .${suffix} file
2514 open(TEMP, "> ${final}.${suffix}") || &tidy_up_and_die(1,"Can't open ${final}.${suffix}\n");
2515 print TEMP "/* OPTIONS " . join(' ',@File_options) . " */\n";
2517 print STDERR "Prepending OPTIONS: " . join(' ',@File_options) . " to ${final}.${suffix}\n" if $Verbose;
2519 $to_do = "$Cat $tmp >> ${final}.${suffix}";
2520 &run_something($to_do, "Saving copy of .${suffix} file");
2527 Command-line processor
2533 # can't use getopt(s); what we want is too complicated
2535 arg: while($_ = $Args[0]) {
2538 #---------- help -------------------------------------------------------
2539 if (/^-\?$/ || /^--?help$/) { print $LongUsage; exit $Status; }
2541 #-----------version ----------------------------------------------------
2542 /^--version$/ && do { print STDERR "${PROJECTNAME}, version ${PROJECTVERSION}, patchlevel ${PROJECTPATCHLEVEL}\n"; exit $Status; };
2544 #---------- verbosity and such -----------------------------------------
2545 /^-v$/ && do { $Verbose = '-v'; $Time = 'time'; next arg; };
2547 #---------- what phases are to be run ----------------------------------
2548 /^-(no-)?recomp/ && do { $Do_recomp_chkr = ($1 ne '') ? 1 : 0; next arg; };
2550 /^-cpp$/ && do { $Cpp_flag_set = 1; next arg; };
2551 # change the global default:
2552 # we won't run cat; we'll run the real thing
2554 /^-C$/ && do { $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0; $HscOut = '-C=';
2556 # stop after generating C
2558 /^-noC$/ && do { $HscOut = '-N='; $ProduceHi = '-nohifile=';
2559 $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0;
2561 # leave out actual C generation (debugging) [also turns off interface gen]
2563 /^-hi$/ && do { $HiOnStdout = 1; $ProduceHi = '-hifile='; next arg; };
2564 # _do_ generate an interface; usually used as: -noC -hi
2566 /^-nohi$/ && do { $ProduceHi = '-nohifile='; next arg; };
2567 # don't generate an interface (even if generating C)
2569 /^-hi-diffs$/ && do { $HiDiff_flag = 'normal'; next arg; };
2570 /^-hi-diffs-with-usages$/ && do { $HiDiff_flag = 'usages'; next arg; };
2571 /^-no-hi-diffs$/ && do { $HiDiff_flag = ''; next arg; };
2572 /^-keep-hi-diffs$/ && do { $Keep_HiDiffs = 1; next arg; };
2574 # show/disable diffs if the interface file changes
2576 /^-E$/ && do { push(@CcBoth_flags, '-E');
2577 $Only_preprocess_C = 1;
2578 $Do_as = 0; $Do_lnkr = 0; next arg; };
2579 # stop after preprocessing C
2580 /^-M$/ && do { $Only_generate_deps = 1; $Do_as = 0; $Do_lnkr = 0; next arg; };
2581 # only generate dependency information.
2582 /^-S$/ && do { $Do_as = 0; $Do_lnkr = 0; next arg; };
2583 # stop after generating assembler
2585 /^-c$/ && do { $Do_lnkr = 0; next arg; };
2586 # stop after generating .o files
2588 /^-link-chk$/ && do { $LinkChk = 1; next arg; };
2589 /^-no-link-chk$/ && do { $LinkChk = 0; next arg; };
2590 # don't do consistency-checking after a link
2592 /^-tmpdir$/ && do { $Tmp_prefix = &grab_arg_arg(*Args,'-tmpdir', '');
2593 $Tmp_prefix = "$Tmp_prefix/ghc$$";
2594 $ENV{'TMPDIR'} = $Tmp_prefix; # for those who use it...
2596 # use an alternate directory for temp files
2598 #---------- redirect output --------------------------------------------
2600 # -o <file>; applies to the last phase, whatever it is
2601 # "-o -" sends it to stdout
2602 # if <file> has a directory component, that dir must already exist
2604 /^-odir$/ && do { $Specific_output_dir = &grab_arg_arg(*Args,'-odir', '');
2606 # Hack, of the worst sort: don't do validation of
2607 # odir argument if you're using -M (dependency generation).
2609 if ( ! $Only_generate_deps && ! -d $Specific_output_dir) {
2610 print STDERR "$Pgm: -odir: no such directory: $Specific_output_dir\n";
2615 /^-o$/ && do { $Specific_output_file = &grab_arg_arg(*Args,'-o', '');
2616 if ($Specific_output_file ne '-'
2617 && $Specific_output_file =~ /(.*)\/[^\/]*$/) {
2618 local($dir_part) = $1;
2619 if (! -d $dir_part) {
2620 print STDERR "$Pgm: no such directory: $dir_part\n";
2626 # NB: -isuf not documented yet (because it doesn't work yet)
2627 /^-isuf$/ && do { $Isuffix = &grab_arg_arg(*Args,'-isuf', '');
2628 if ($Isuffix =~ /\./ ) {
2629 print STDERR "$Pgm: -isuf suffix shouldn't contain a .\n";
2634 /^-osuf$/ && do { $Osuffix = &grab_arg_arg(*Args,'-osuf', '');
2635 if ($Osuffix =~ /\./ ) {
2636 print STDERR "$Pgm: -osuf suffix shouldn't contain a .\n";
2641 # -ohi <file>; send the interface to <file>; "-ohi -" to send to stdout
2642 /^-ohi$/ && do { $Specific_hi_file = &grab_arg_arg(*Args,'-ohi', '');
2643 if ($Specific_hi_file ne '-'
2644 && $Specific_hi_file =~ /(.*)\/[^\/]*$/) {
2645 local($dir_part) = $1;
2646 if (! -d $dir_part) {
2647 print STDERR "$Pgm: no such directory: $dir_part\n";
2653 # The suffix to use when looking for interface files
2654 /^-hisuf$/ && do { $HiSuffix = &grab_arg_arg(*Args,'-hisuf', '');
2655 if ($HiSuffix =~ /\./ ) {
2656 print STDERR "$Pgm: -hisuf suffix shouldn't contain a .\n";
2660 # ToDo: remove, not a `normal' user thing to do (should be automatic)
2661 /^-hisuf-prelude$/ && do { $HiSuffix_prelude = &grab_arg_arg(*Args,'-hisuf-prelude', '');
2662 if ($HiSuffix =~ /\./ ) {
2663 print STDERR "$Pgm: -hisuf-prelude suffix shouldn't contain a .\n";
2667 /^-odump$/ && do { $Specific_dump_file = &grab_arg_arg(*Args,'-odump', '');
2668 if ($Specific_dump_file =~ /(.*)\/[^\/]*$/) {
2669 local($dir_part) = $1;
2670 if (! -d $dir_part) {
2671 print STDERR "$Pgm: no such directory: $dir_part\n";
2677 #-------------- scc & Profiling Stuff ----------------------------------
2679 /^-prof$/ && do { $PROFing = 'p'; next arg; }; # profiling -- details later!
2682 # generate auto SCCs on top level bindings
2683 # -auto-all = all top level bindings
2684 # -auto = only top level exported bindings
2685 $PROFauto = ( /-all/ )
2686 ? '-fauto-sccs-on-all-toplevs'
2687 : '-fauto-sccs-on-exported-toplevs';
2690 /^-caf-all/ && do { # generate individual CAF SCC annotations
2691 $PROFcaf = '-fauto-sccs-on-individual-cafs';
2694 /^-ignore-scc$/ && do {
2695 # forces ignore of scc annotations even if profiling
2696 $PROFignore_scc = '-W';
2699 /^-G(.*)$/ && do { push(@HsC_flags, "-G=$1"); # set group for cost centres
2702 /^-unprof-scc-auto/ && do {
2703 # generate auto SCCs on top level bindings when not profiling.
2704 # Used to measure optimisation effects of presence of sccs.
2705 $UNPROFscc_auto = ( /-all/ )
2706 ? '-fauto-sccs-on-all-toplevs'
2707 : '-fauto-sccs-on-exported-toplevs';
2710 #--------- ticky/concurrent/parallel -----------------------------------
2711 # we sort out the details a bit later on
2713 /^-concurrent$/ && do { $CONCURing = 'c'; next arg; }; # concurrent Haskell
2714 /^-gransim$/ && do { $GRANing = 'g'; next arg; }; # GranSim
2715 /^-ticky$/ && do { $TICKYing = 't'; next arg; }; # ticky-ticky
2716 /^-parallel$/ && do { $PARing = 'p'; next arg; }; # parallel Haskell
2718 #-------------- "user ways" --------------------------------------------
2720 (/^-user-setup-([a-oA-Z])$/ ) &&
2722 /^-user-setup-([a-oA-Z])$/ && do { $BuildTag = "_$1"; };
2724 local($stuff) = $UserSetupOpts{$BuildTag};
2725 local(@opts) = split(/\s+/, $stuff);
2727 # feed relevant ops into the arg-processing loop (if any)
2728 unshift(@Args, @opts) if $#opts >= 0;
2732 #---------- set search paths for libraries and things ------------------
2734 # we do -i just like HBC (-i clears the list; -i<colon-separated-items>
2735 # prepends the items to the list); -I is for including C .h files.
2737 /^-i$/ && do { @Import_dir = (); # import path cleared!
2738 @SysImport_dir = ();
2739 print STDERR "WARNING: import paths cleared by `-i'\n";
2742 /^-i(.*)/ && do { local(@new_items)
2743 = split( /:/, &grab_arg_arg(*Args,'-i', $1));
2744 unshift(@Import_dir, @new_items);
2747 /^-I(.*)/ && do { push(@Include_dir, &grab_arg_arg(*Args,'-I', $1)); next arg; };
2748 /^-L(.*)/ && do { push(@UserLibrary_dir, &grab_arg_arg(*Args,'-L', $1)); next arg; };
2749 /^-l(.*)/ && do { push(@UserLibrary,'-l'.&grab_arg_arg(*Args,'-l', $1)); next arg; };
2751 /^-syslib(.*)/ && do { local($syslib) = &grab_arg_arg(*Args,'-syslib',$1);
2752 print STDERR "$Pgm: no such system library (-syslib): $syslib\n",
2753 $Status++ unless $syslib =~ /^(hbc|ghc|posix|contrib)$/;
2755 unshift(@SysImport_dir,
2757 ? "$InstSysLibDir/$syslib/imports"
2758 : "$TopPwd/hslibs/$syslib/src");
2760 if ( ${INSTALLING} ) {
2761 push(@SysLibrary_dir,
2762 ("$InstSysLibDir"));
2764 push(@SysLibrary_dir,
2765 ("$TopPwd/hslibs/$syslib"
2766 ,"$TopPwd/hslibs/$syslib/cbits"));
2769 push(@SysLibrary, "-lHS$syslib");
2770 push(@SysLibrary, "-lHS${syslib}_cbits")
2771 unless $syslib eq 'contrib'; #HACK! it has no cbits
2775 #=======================================================================
2776 # various flags that we can harmlessly send to one program or another
2777 # (we will later "reclaim" some of the compiler ones now sent to gcc)
2778 #=======================================================================
2780 #---------- this driver itself (ghc) -----------------------------------
2781 # these change what executable is run for each phase:
2782 /^-pgmL(.*)$/ && do { $Unlit = $1; next arg; };
2783 /^-pgmP(.*)$/ && do { $HsCpp = $1; next arg; };
2784 /^-pgmC(.*)$/ && do { $HsC = $1; next arg; };
2785 /^-pgmcO?(.*)$/ && do { $CcRegd = $1; next arg; }; # the O? for back compat
2786 /^-pgma(.*)$/ && do { $As = $1; next arg; };
2787 /^-pgml(.*)$/ && do { $Lnkr = $1; next arg; };
2788 /^-pgmdep(.*)$/ && do { $MkDependHS = $1; next arg; };
2790 #---------- the get-anything-through opts (all pgms) -------------------
2791 # these allow arbitrary option-strings to go to any phase:
2792 /^-optL(.*)$/ && do { push(@Unlit_flags, $1); next arg; };
2793 /^-optP(.*)$/ && do { push(@HsCpp_flags, $1); next arg; };
2794 /^-optCrts(.*)$/&& do { push(@HsC_rts_flags, $1); next arg; };
2795 /^-optC(.*)$/ && do { push(@HsC_flags, $1); next arg; };
2796 /^-optcpp(.*)$/ && do { push(@Cpp_define, $1); $Only_preprocess_hc = ($1 eq "-E"); next arg; };
2797 /^-optc(.*)$/ && do { push(@CcBoth_flags, $1); next arg; };
2798 /^-opta(.*)$/ && do { push(@As_flags, $1); next arg; };
2799 /^-optl(.*)$/ && do { push(@Ld_flags, $1); next arg; };
2800 /^-optdep(.*)$/ && do { push(@MkDependHS_flags, $1); next arg; };
2802 #---------- Haskell C pre-processor (hscpp) ----------------------------
2803 /^-D(.*)/ && do { push(@HsCpp_flags, "'-D".&grab_arg_arg(*Args,'-D',$1)."'"); next arg; };
2804 /^-U(.*)/ && do { push(@HsCpp_flags, "'-U".&grab_arg_arg(*Args,'-U',$1)."'"); next arg; };
2806 /^-genSPECS/ && do { $Cpp_flag_set = 1;
2807 $genSPECS_flag = $_;
2810 #---------- post-Haskell "assembler"------------------------------------
2811 /^-ddump-raw-asm$/ && do { $Dump_raw_asm = 1; next arg; };
2812 /^-ddump-asm-splitting-info$/ && do { $Dump_asm_splitting_info = 1; next arg; };
2814 #---------- Haskell compiler (hsc) -------------------------------------
2816 /^-keep-hc-files?-too$/ && do { $Keep_hc_file_too = 1; next arg; };
2817 /^-keep-s-files?-too$/ && do { $Keep_s_file_too = 1; next arg; };
2819 /^-fhaskell-1\.3$/ && do { next arg; }; # a no-op right now
2821 /^-fignore-interface-pragmas$/ && do { push(@HsC_flags, $_); next arg; };
2823 /^-fno-implicit-prelude$/ && do { $NoImplicitPrelude= 1; push(@HsC_flags, $_); next arg; };
2824 # don't do stack checking using page fault `trick'.
2826 /^-fstack-check$/ && do { $StkChkByPageFaultOK = 0; next arg; };
2828 # have the compiler proper generate concurrent code,
2829 # really only used when you want to configure your own
2830 # special user compilation way. (Use -concurrent when
2831 # compiling `Concurrent Haskell' programs).
2833 # (ditto for -fgransim, fscc-profiling and -fticky-ticky)
2835 /^-fconcurrent$/ && do { push(@HsC_flags,$_); next arg; };
2836 /^-fscc-profiling$/ && do { push(@HsC_flags,$_); next arg; };
2837 /^-fticky-ticky$/ && do { push(@HsC_flags,$_); next arg; };
2838 /^-fgransim$/ && do { push(@HsC_flags,$_); next arg; };
2840 /^-user-prelude-force/ && do { # ignore if not -user-prelude
2843 /^-split-objs/ && do {
2844 if ( $TargetPlatform !~ /^(alpha|hppa1\.1|i386|m68k|mips|powerpc|rs6000|sparc)-/ ) {
2846 print STDERR "WARNING: don't know how to split objects on this platform: $TargetPlatform\n`-split-objs' option ignored\n";
2851 push(@HsC_flags, "-fglobalise-toplev-names");
2852 push(@CcBoth_flags, '-DUSE_SPLIT_MARKERS');
2854 require('ghc-split.prl')
2855 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-split.prl!\n");
2860 && do { push(@HsC_flags, $_);
2861 push(@HsP_flags, '-N');
2863 # push(@HsC_flags, '-fshow-import-specs');
2867 /^-fspeciali[sz]e-unboxed$/
2868 && do { $Oopt_DoSpecialise = '-fspecialise';
2869 $Oopt_SpecialiseUnboxed = '-fspecialise-unboxed';
2872 && do { $Oopt_DoSpecialise = '-fspecialise'; next arg; };
2873 /^-fno-speciali[sz]e$/
2874 && do { $Oopt_DoSpecialise = ''; next arg; };
2877 # Now the foldr/build options, which are *on* by default (for -O).
2880 && do { $Oopt_FoldrBuild = 1;
2881 $Oopt_FB_Support = '-fdo-arity-expand';
2885 /^-fno-foldr-build$/
2886 && do { $Oopt_FoldrBuild = 0;
2887 $Oopt_FB_Support = '';
2890 /^-fno-foldr-build-rule$/
2891 && do { $Oopt_FoldrBuild = 0;
2894 /^-fno-enable-tech$/
2895 && do { $Oopt_FB_Support = '';
2898 /^-fno-snapback-to-append$/
2899 && do { $Oopt_FoldrBuildInline .= ' -fdo-not-fold-back-append ';
2902 # --------------- Renamer -------------
2905 /^-fno-prune-tydecls$/ && do { push(@HsC_flags, $_); next arg; };
2906 /^-fno-prune-instdecls$/ && do { push(@HsC_flags, $_); next arg; };
2910 /^-fasm-(.*)$/ && do { $HscOut = '-S='; next arg; }; # force using nativeGen
2911 /^-fvia-[cC]$/ && do { $HscOut = '-C='; next arg; }; # force using C compiler
2915 /^(-funfolding-use-threshold)(.*)$/
2916 && do { $Oopt_UnfoldingUseThreshold = $1 . &grab_arg_arg(*Args,$1, $2);
2919 /^(-fmax-simplifier-iterations)(.*)$/
2920 && do { $Oopt_MaxSimplifierIterations = $1 . &grab_arg_arg(*Args,$1, $2);
2922 /^(-fshow-simplifier-progress)/
2923 && do { $Oopt_ShowSimplifierProgress = $1;
2926 /^-fno-pedantic-bottoms$/
2927 && do { $Oopt_PedanticBottoms = ''; next arg; };
2929 /^-fdo-monad-eta-expansion$/
2930 && do { $Oopt_MonadEtaExpansion = $_; next arg; };
2932 /^-fno-let-from-(case|app|strict-let)$/ # experimental, really (WDP 95/10)
2933 && do { push(@HsC_flags, $_); next arg; };
2935 /^(-freturn-in-regs-threshold)(.*)$/
2936 && do { local($what) = $1;
2937 local($num) = &grab_arg_arg(*Args,$what, $2);
2938 if ($num < 2 || $num > 8) {
2939 die "Bad experimental flag: $_\n";
2941 $HscOut = '-C='; # force using C compiler
2942 push(@HsC_flags, "$what$num");
2943 push(@CcRegd_flags, "-D__STG_REGS_AVAIL__=$num");
2947 # --------------- Warnings etc. ------
2949 /^-fshow-import-specs/
2950 && do { push(@HsC_flags, $_); next arg; };
2952 # for now, just -fwarn-name-shadowing
2953 /^-fwarn-(.*)$/ && do { push(@HsC_flags, $_); next arg; };
2955 /^-fno-warn-(.*)$/ && do { push(@HsC_flags, "-fno-warn-$1"); next arg; };
2957 /^-fno-(.*)$/ && do { push(@HsC_antiflags, "-f$1");
2958 &squashHscFlag("-f$1");
2961 # --------------- platform specific flags (for gcc mostly) ----------------
2963 /^-mlong-calls$/ && do { # for GCC for HP-PA boxes,
2964 # for 2.6.x..?, does not apply for 2.7.2
2966 unshift(@CcBoth_flags, ( $_ ));
2969 /^-m(v8|sparclite|cypress|supersparc|cpu=(cypress|supersparc))$/
2970 && do { # for GCC for SPARCs
2971 unshift(@CcBoth_flags, ( $_ ));
2974 /^-monly-([432])-regs/ && do { # for iX86 boxes only; no effect otherwise
2975 $StolenX86Regs = $1;
2978 #*************** ... and lots of debugging ones (form: -d* )
2980 # -d(no-)core-lint is done this way so it is turn-off-able.
2981 /^-dcore-lint/ && do { $CoreLint = '-dcore-lint'; next arg; };
2982 /^-dno-core-lint/ && do { $CoreLint = ''; next arg; };
2983 # Ditto for STG lint
2984 /^-dstg-lint/ && do { $StgLint = '-dstg-lint'; next arg; };
2985 /^-dno-stg-lint/ && do { $StgLint = ''; next arg; };
2987 /^-d(dump|ppr)-/ && do { push(@HsC_flags, $_); next arg; };
2988 /^-dverbose-(simpl|stg)/ && do { push(@HsC_flags, $_); next arg; };
2989 /^-dshow-passes/ && do { push(@HsC_flags, $_); next arg; };
2990 /^-dshow-rn-stats/ && do { push(@HsC_flags, $_); next arg; };
2991 /^-dshow-rn-trace/ && do { push(@HsC_flags, $_); next arg; };
2992 /^-dsource-stats/ && do { push(@HsC_flags, $_); next arg; };
2993 /^-dsimplifier-stats/ && do { push(@HsC_flags, $_); next arg; };
2994 /^-dstg-stats/ && do { $Oopt_StgStats = $_; next arg; };
2996 #*************** ... and now all these -R* ones for its runtime system...
2998 /^-Rscale-sizes?(.*)/ && do {
2999 $Scale_sizes_by = &grab_arg_arg(*Args,'-Rscale-sizes', $1);
3002 /^(-H|-Rmax-heapsize)(.*)/ && do {
3003 local($heap_size) = &grab_arg_arg(*Args,$1, $2);
3004 if ($heap_size =~ /(\d+)[Kk]$/) {
3005 $heap_size = $1 * 1000;
3006 } elsif ($heap_size =~ /(\d+)[Mm]$/) {
3007 $heap_size = $1 * 1000 * 1000;
3008 } elsif ($heap_size =~ /(\d+)[Gg]$/) {
3009 $heap_size = $1 * 1000 * 1000 * 1000;
3011 if ($heap_size <= 0) {
3012 print STDERR "$Pgm: resetting heap-size to zero!!! $heap_size\n";
3013 $Specific_heap_size = 0;
3015 # if several heap sizes given, take the largest...
3016 } elsif ($heap_size >= $Specific_heap_size) {
3017 $Specific_heap_size = $heap_size;
3019 print STDERR "$Pgm: ignoring heap-size-setting option ($_)...not the largest seen\n";
3023 /^-(K|Rmax-(stk|stack)size)(.*)/ && do {
3025 local($stk_size) = &grab_arg_arg(*Args,'-Rmax-stksize', $3);
3026 if ($stk_size =~ /(\d+)[Kk]$/) {
3027 $stk_size = $1 * 1000;
3028 } elsif ($stk_size =~ /(\d+)[Mm]$/) {
3029 $stk_size = $1 * 1000 * 1000;
3030 } elsif ($stk_size =~ /(\d+)[Gg]$/) {
3031 $stk_size = $1 * 1000 * 1000 * 1000;
3033 if ($stk_size <= 0) {
3034 print STDERR "$Pgm: resetting stack-size to zero!!! $stk_size\n";
3035 $Specific_stk_size = 0;
3037 # if several stack sizes given, take the largest...
3038 } elsif ($stk_size >= $Specific_stk_size) {
3039 $Specific_stk_size = $stk_size;
3041 print STDERR "$Pgm: ignoring stack-size-setting option ($flag $stk_size)...not the largest seen\n";
3045 /^-Rgc-stats$/ && do { $CollectingGCstats++;
3046 # the two RTSs do this diff ways; we will try to compensate
3049 /^-Rghc-timing/ && do { $CollectGhcTimings = 1; next arg; };
3051 #---------- C high-level assembler (gcc) -------------------------------
3052 /^-(Wall|ansi|pedantic)$/ && do { push(@CcBoth_flags, $_); next arg; };
3054 # -dgcc-lint is a useful way of making GCC very fussy.
3055 # From alan@spri.levels.unisa.edu.au (Alan Modra).
3056 /^-dgcc-lint$/ && do { push(@CcBoth_flags, '-Wall -Wpointer-arith -Wbad-function-cast -Wcast-qual -Wstrict-prototypes -Wmissing-prototypes -Wmissing-declarations -Wnested-externs'); next arg; };
3057 # An alternate set, from mark@sgcs.com (Mark W. Snitily)
3058 # -Wall -Wstrict-prototypes -Wmissing-prototypes -Wcast-align -Wshadow
3060 # inject "#include <wurble>" into the compiler's C output!
3062 /^-#include(.*)/ && do {
3063 local($to_include) = &grab_arg_arg(*Args,'-#include', $1);
3064 push(@CcInjects, "#include $to_include\n");
3067 #---------- Linker (gcc, really) ---------------------------------------
3069 /^-static$/ && do { push(@Ld_flags, $_); next arg; };
3071 #---------- mixed cc and linker magic ----------------------------------
3072 # this optimisation stuff is finally sorted out later on...
3074 /^-O2-for-C$/ && do { $MinusO2ForC = 1; next arg; };
3076 /^-O[1-2]?$/ && do {
3077 local($opt_lev) = ( /^-O2$/ ) ? 2 : 1; # max 'em
3078 $OptLevel = ( $opt_lev > $OptLevel ) ? $opt_lev : $OptLevel;
3080 $HscOut = '-C=' if $OptLevel == 2; # force use of C compiler
3083 /^-Onot$/ && do { $OptLevel = 0; next arg; }; # # set it to <no opt>
3085 /^-Ofile(.*)/ && do {
3087 local($ofile) = &grab_arg_arg(*Args,'-Ofile', $1);
3088 @HsC_minusO3_flags = ();
3090 open(OFILE, "< $ofile") || die "Can't open $ofile!\n";
3093 s/\#.*//; # death to comments
3094 s/[ \t]+//g; # death to whitespace
3095 next if /^$/; # ditto, blank lines
3096 s/([()*{}])/\\$1/g; # protect shell metacharacters
3098 push(@CcBoth_flags, $1);
3100 push(@HsC_minusO3_flags, $_);
3106 /^-debug$/ && do { # all this does is mark a .hc/.o as "debugging"
3107 # in the consistency info
3111 #---------- linking .a file --------------------------------------------
3113 /^-Main(.*)/ && do {
3114 # specifies main or mainPrimIO to be linked
3118 #---------- catch unrecognized flags -----------------------------------
3121 print STDERR "$Pgm: unrecognised option: $_\n";
3127 } # end of processArgs