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 Warning packages that are controlled by -W and -Wall. The 'standard'
271 warnings that you get all the time are
273 -fwarn-overlapping-patterns
274 -fwarn-missing-methods
275 -fwarn-duplicate-exports
277 these are turned off by -Wnot.
280 @StandardWarnings = ('-fwarn-overlapping-patterns',
281 '-fwarn-missing-methods',
282 '-fwarn-duplicate-exports');
283 @MinusWOpts = (@StandardWarnings,
284 '-fwarn-incomplete-patterns',
285 '-fwarn-unused-names');
286 @MinusWallOpts = (@MinusWOpts,
287 '-fwarn-name-shadowing');
290 What options \tr{-user-setup-a} turn into (user-defined ``packages''
292 of options). Note that a particular user-setup implies a particular
293 Prelude ({\em including} its interface file(s)).
295 $BuildTag = ''; # default is sequential build w/ Appel-style GC
297 %BuildDescr = (# system ways begin
298 '', 'normal sequential',
302 '_mc', "$WAY_mc_NAME",
303 '_mr', "$WAY_mr_NAME",
304 '_mt', "$WAY_mt_NAME",
305 '_mp', "$WAY_mp_NAME",
306 '_mg', "$WAY_mg_NAME",
307 '_2s', "$WAY_2s_NAME",
308 '_1s', "$WAY_1s_NAME",
309 '_du', "$WAY_du_NAME",
327 '_B', "$WAY_B_NAME" );
329 # these are options that are "fed back" through the option processing loop
333 '_a', "$WAY_a_HC_OPTS",
334 '_b', "$WAY_b_HC_OPTS",
335 '_c', "$WAY_c_HC_OPTS",
336 '_d', "$WAY_d_HC_OPTS",
337 '_e', "$WAY_e_HC_OPTS",
338 '_f', "$WAY_f_HC_OPTS",
339 '_g', "$WAY_g_HC_OPTS",
340 '_h', "$WAY_h_HC_OPTS",
341 '_i', "$WAY_i_HC_OPTS",
342 '_j', "$WAY_j_HC_OPTS",
343 '_k', "$WAY_k_HC_OPTS",
344 '_l', "$WAY_l_HC_OPTS",
345 '_m', "$WAY_m_HC_OPTS",
346 '_n', "$WAY_n_HC_OPTS",
347 '_o', "$WAY_o_HC_OPTS",
348 '_A', "$WAY_A_HC_OPTS",
349 '_B', "$WAY_B_HC_OPTS",
352 '_p', "$WAY_p_HC_OPTS",
353 '_t', "$WAY_t_HC_OPTS",
354 '_u', "$WAY_u_HC_OPTS",
355 '_mc', "$WAY_mc_HC_OPTS",
356 '_mr', "$WAY_mr_HC_OPTS",
357 '_mt', "$WAY_mt_HC_OPTS",
358 '_mp', "$WAY_mp_HC_OPTS",
359 '_mg', "$WAY_mg_HC_OPTS",
360 '_2s', "$WAY_2s_HC_OPTS",
361 '_1s', "$WAY_1s_HC_OPTS",
362 '_du', "$WAY_B_HC_OPTS" );
366 Import/include directories (\tr{-I} options) are sufficiently weird to
367 require special handling.
370 @Import_dir = ('.'); #-i things
371 @Include_dir = ('.'); #-I things; other default(s) stuck on AFTER option processing
373 # where to look for interface files (system hi's, i.e., prelude and hslibs)
374 @SysImport_dir = ( $INSTALLING )
375 ? ( "$InstLibDirGhc/imports" )
376 : ( "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/required"
377 , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/ghc"
378 , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/glaExts"
379 , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/concurrent" );
381 # We need to look in ghc/ and glaExts/ when searching for implicitly needed .hi files, but
382 # we should really *not* look there for explicitly imported modules.
384 $GhcVersionInfo = int($PROJECTVERSION * 100 + .5); # i.e., round (X.Y * 100)
385 $Haskell1Version = 4; # i.e., Haskell 1.4
388 @UserLibrary_dir= (); #-L things;...
389 @UserLibrary = (); #-l things asked for by the user
391 @SysLibrary_dir = ( ( $INSTALLING ) #-syslib things supplied by the system
393 : ( "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR"
394 , "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR/gmp"
395 , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR"
396 , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/cbits"
399 @SysLibrary = (); # will be built up as we go along
401 $TopClosureFile # defaults to 1.2 one; will be mangled later
402 = ( $INSTALLING) ? "$InstLibDirGhc/TopClosureXXXX.o"
403 : "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR/main/TopClosureXXXX.o";
405 # make depend for Haskell
407 = ( $INSTALLING ) ? "$InstBinDirGhc/mkdependHS"
408 : "$TopPwd/$CURRENT_DIR/$GHC_UTILS_DIR/mkdependHS/mkdependHS";
410 @MkDependHS_flags = ();
412 # do_link flag should not be reset while rescanning the cmd-line.
414 $Specific_output_dir = ''; # set by -odir <dir>
415 $Specific_output_file = ''; # set by -o <file>; "-" for stdout
418 Function to initialise the per-compilation-unit globals that
419 are used to guide and control the invocation of the different phases.
422 sub initDriverGlobals {
424 # reset the following options:
425 # RTS flags to use while compiling
427 @HsP_flags = (); # these are the flags destined solely for
428 # the flex/yacc parser
433 The optimisations/etc to be done by the compiler are {\em normally}
434 expressed with a \tr{-O} (or \tr{-O2}) flag, or by its absence.
437 $OptLevel = 0; # no -O == 0; -O == 1; -O2 == 2; -Ofile == 3
438 $MinusO2ForC = 0; # set to 1 if -O2 should be given to C compiler
439 $StolenX86Regs = 4; # **HACK*** of the very worst sort
443 @CcBoth_flags = ('-S'); # flags for *any* C compilation
446 # GCC flags: those for all files, those only for .c files; those only for .hc files
447 @CcRegd_flags = ('-ansi', '-D__STG_GCC_REGS__', '-D__STG_TAILJUMPS__');
448 @CcRegd_flags_c = ();
449 @CcRegd_flags_hc = ();
451 @Import_dir = ('.'); #-i things
452 @Include_dir = ('.'); #-I things; other default(s) stuck on AFTER option processing
457 We are given a list of files with various presumably-known suffixes
458 (unknown-suffix files go straight to the linker). For each file, we
459 begin by assuming that we'll run every phase over it. However: (1)
460 global flags (\tr{-c}, \tr{-S}, etc.) tell us not to run any phase
461 past a certain point; and (2) the file's suffix tells us what phase to
462 start with. Linking is weird and kept track of separately.
464 Here are the initial defaults applied to all files:
466 $Cpp_flag_set = 0; # (hack)
467 $Only_preprocess_C = 0; # pretty hackish
468 $Only_preprocess_hc = 0; # ditto
469 $Only_generate_deps = 0; # "
470 $PostprocessCcOutput = 0;
472 # native code-gen or via C?
473 $HaveNativeCodeGen = $GhcWithNativeCodeGen;
474 $HscOut = '-C='; # '-C=' ==> .hc output; '-S=' ==> .s output; '-N=' ==> neither
476 if $HaveNativeCodeGen && $TargetPlatform =~ /^(alpha|sparc)-/;
477 # TEMP: disable x86 if $HaveNativeCodeGen && $TargetPlatform =~ /^(i386|alpha|sparc)-/;
478 $ProduceHi = '-hifile=';
483 $CollectingGCstats = 0;
484 $CollectGhcTimings = 0;
485 $DEBUGging = ''; # -DDEBUG and all that it entails (um... not really)
486 $PROFing = ''; # set to p or e if profiling
487 $PROFgroup = ''; # set to group if an explicit -Ggroup specified
488 $PROFauto = ''; # set to relevant hsc flag if -auto or -auto-all
489 $PROFcaf = ''; # set to relevant hsc flag if -caf-all
490 $PROFignore_scc = ''; # set to relevant parser flag if explicit sccs ignored
491 $UNPROFscc_auto = ''; # set to relevant hsc flag if forcing auto sccs without profiling
492 $TICKYing = ''; # set to t if compiling for ticky-ticky profiling
493 $PARing = ''; # set to p if compiling for PAR
494 $CONCURing = ''; # set to c if compiling for CONCURRENT
495 $GRANing = ''; # set to g if compiling for GRAN
496 $StkChkByPageFaultOK = 1; # may be set to 0 (false) for some builds
497 $Specific_hi_file = ''; # set by -ohi <file>; "-" for stdout
498 $Specific_dump_file = ''; # set by -odump <file>; "-" for stdout
499 $Using_dump_file = 0;
501 $Osuffix = ''; # default: use the normal suffix for that kind of output
503 $HiSuffix_prelude = '';
504 $Do_recomp_chkr = 0; # don't use the recompilatio checker unless asked
505 $Do_cc = -1; # a MAGIC indeterminate value; will be set to 1 or 0.
508 $Keep_hc_file_too = 0;
509 $Keep_s_file_too = 0;
510 $UseGhcInternals = 0; # if 1, may use GHC* modules
513 $Dump_parser_output = 0;
515 $Dump_asm_splitting_info = 0;
516 $NoImplicitPrelude = 0;
519 } # end of initDriverGlobals (Sigh)
521 # we split the argv passed to the driver into three:
526 # and files to be linked...
532 # cmd line options prefixing the unit we're compiling
537 We inject consistency-checking information into \tr{.hc} files (both
538 when created by the Haskell compiler and when compiled by the C
539 compiler), so that we can check that an executable is made from
540 consistently-built pieces. (The check is normally done just after
541 linking.) The checking is done by introducing/munging
542 \tr{what(1)}-style strings. Anyway, here are the relevant global
543 variables and their defaults:
545 $LinkChk = 1; # set to 0 if the link check should *not* be done
547 # major & minor version numbers; major numbers must always agree;
548 # minor disagreements yield a warning.
549 $HsC_major_version = 33;
550 $HsC_minor_version = 0;
551 $Cc_major_version = 36;
552 $Cc_minor_version = 1;
554 # options: these must always agree
555 $HsC_consist_options = ''; # we record, in this order:
556 # Build tag; debugging?
557 $Cc_consist_options = ''; # we record, in this order:
558 # Build tag; debugging?
561 %************************************************************************
563 \section[Driver-parse-argv]{Munge the command-line options}
565 %************************************************************************
567 Now slurp through the arguments.
570 &initDriverGlobals();
571 &splitCmdLine(@ARGV);
572 # Run through the cmd-line first time.
573 &processArgs(@Cmd_opts);
575 # Check to see if driver is only in the business
576 # to generate dependencies
577 if ( $Status == 0 && $Only_generate_deps ) {
579 push (@MkDependHS_flags, "-o$Osuffix") if $Osuffix;
580 push (@MkDependHS_flags, "-s$BuildTag") if $BuildTag;
581 push (@MkDependHS_flags, "-D__HASKELL1__=$Haskell1Version");
582 # They're not (currently) needed, but we need to quote any -#include options
583 foreach (@Cmd_opts) {
584 s/-#include.*$/'$&'/g;
586 local($to_do) = "$MkDependHS @MkDependHS_flags -- @Cmd_opts -- @Input_file" ;
587 &run_something($to_do, 'Haskell dependencies');
591 # if there are several input files,
592 # we don't allow \tr{-o <file>} or \tr{-ohi <file>} options...
593 # (except if linking, of course)
595 if ($#Input_file > 0 && ( ! $Do_lnkr )) {
596 if ( ($Specific_output_file ne '' && $Specific_output_file ne '-')
597 || ($Specific_hi_file ne '' && $Specific_hi_file ne '-') ) {
598 print STDERR "$Pgm: You can't use -o or -ohi options if you have multiple input files.\n";
599 print STDERR "\tPerhaps the -odir option will do what you want.\n";
604 # check for various pathological -o and -odir combinations...
605 if ($Specific_output_dir ne '' && $Specific_output_file ne '') {
606 if ($Specific_output_file eq '-') {
607 print STDERR "$Pgm: can't set output directory with -ohi AND have output to stdout\n";
609 } else { # amalgamate...
610 $Specific_output_file = "$Specific_output_dir/$Specific_output_file";
611 # ToDo: check we haven't got a junk name now...
612 $Specific_output_dir = ''; # reset
616 # crash and burn if there were errors
618 print STDERR $ShortUsage;
623 %************************************************************************
625 \section[Driver-post-argv-mangling]{Setup after reading options}
627 %************************************************************************
629 %************************************************************************
631 \subsection{Set up for optimisation level (\tr{-O} or whatever)}
633 %************************************************************************
635 We come now to the default ``wads of options'' that are turned on by
636 \tr{-O0} (do min optimisation), \tr{-O} (ordinary optimisation),
637 \tr{-O2} (aggressive optimisation), or no O-ish flag (compile speed is
640 The user can also specify his/her own list of options in a file; in
641 that case, the work is already done (see stuff about @minusO3@,
644 GHC allows very precise control of what happens during a compilation.
645 Core-to-Core and STG-to-STG passes can be run in any order, as many
646 times as you like. Individual transformations can be turned on or
649 Sadly, however, there are some interdependencies \& Things You Must
650 Not Do. Here is the list.
654 \item[\tr{-fspecialise}:]
655 The specialiser must have dependency-analysed input; but if you run
656 the simplifier to do this, you must not let it toss away unused
657 bindings! (The typechecker conveys some specialisation info via
658 ``unused'' bindings...)
660 \item[\tr{-ffloat-inwards}:]
661 Floating inwards should be done before strictness analysis, because
662 the latter will give better results.
664 \item[\tr{-fstatic-args}:]
665 The static-arguments-transformation pass {\em must} have the
666 simplifier run right after it.
668 \item[\tr{-fcalc-inlinings[12]}:]
669 Not required, but there may be slight gains by re-simplifying after
670 this is done. (You could then \tr{-fcalc-inlinings} again, just for
673 \item[\tr{-ffull-laziness}:]
674 The (outwards-)let-floater should be the {\em last} Core-to-Core pass
675 that's run. (Um, well, howzabout the simplifier just once more...)
680 \item[\tr{-fupdate-analysis}:]
681 It really really wants to be the last STG-to-STG pass that is run.
686 sub setupOptimiseFlags {
692 '-ffloat-lets-exposing-whnf',
693 '-ffloat-primops-ok',
696 # '-fdo-lambda-eta-expansion', # too complicated
698 # '-flet-to-case', # no strictness analysis, so...
699 $Oopt_PedanticBottoms,
700 # $Oopt_MonadEtaExpansion, # no thanks
702 # These two work fine, if you really want no simplification at all,
703 # for bizarre test reasons. But you get really terrible code if you use them,
704 # for example: let x = e in x
705 # with dozens of redundant thunks etc. So I'm leaving them out.
707 # '-fsimpl-uf-use-threshold0',
708 # '-fessential-unfoldings-only',
710 $Oopt_UnfoldingUseThreshold,
711 $Oopt_MaxSimplifierIterations,
712 $Oopt_ShowSimplifierProgress,
715 # '-ffull-laziness', # removed 95/04 WDP following Andr\'e's lead
717 $Oopt_FinalStgProfilingMassage
720 @HsC_minusO_flags # NOTE: used for *both* -O and -O2 (some conditional bits)
722 '-fdo-eta-reduction',
724 # initial simplify: mk specialiser happy: minimum effort please
728 '-fkeep-spec-pragma-ids', # required before specialisation
730 # I don't understand why we want -fessential-unfoldings-only here
731 # If we have it, the following nasty thing happens:
735 # where "*" means exported.
736 # In the essential-unfoldings pass we still substitute f for g
737 # but we don't substitute E for f first. So we get
741 # The g=f will get reverse-substituted later, but it's untidy.
743 # '-fessential-unfoldings-only',
744 # '-fsimpl-uf-use-threshold0',
746 '-fmax-simplifier-iterations1',
747 $Oopt_PedanticBottoms,
750 ($Oopt_DoSpecialise) ? (
751 '-fspecialise-overloaded',
752 $Oopt_SpecialiseUnboxed,
756 '-fsimplify', # need dependency anal after specialiser ...
757 '[', # need tossing before calc-inlinings ...
759 '-ffloat-lets-exposing-whnf',
760 '-ffloat-primops-ok',
764 # '-fdo-eta-reduction',
765 '-fdo-lambda-eta-expansion',
767 $Oopt_PedanticBottoms,
768 $Oopt_MonadEtaExpansion,
769 $Oopt_UnfoldingUseThreshold,
770 $Oopt_MaxSimplifierIterations,
771 $Oopt_ShowSimplifierProgress,
774 #LATER: '-fcalc-inlinings1', -- pointless for 2.01
776 # ($Oopt_FoldrBuildWW) ? (
777 # '-ffoldr-build-ww-anal',
778 # '-ffoldr-build-worker-wrapper',
782 # '-ffloat-lets-exposing-whnf',
783 # '-ffloat-primops-ok',
787 # '-fdo-eta-reduction',
788 # '-fdo-lambda-eta-expansion',
790 # $Oopt_PedanticBottoms,
791 # $Oopt_MonadEtaExpansion,
792 # $Oopt_UnfoldingUseThreshold,
793 # $Oopt_MaxSimplifierIterations,
794 # $Oopt_ShowSimplifierProgress,
798 # this pass-ordering sequence was agreed by Simon and Andr\'e
799 # (WDP 94/07, 94/11).
802 ($Oopt_FoldrBuild) ? (
803 '-ffoldr-build-on', # desugar list comprehensions for foldr/build
807 '-fignore-inline-pragma', # **** NB!
808 '-fdo-foldr-build', # NB
810 '-ffloat-lets-exposing-whnf',
811 '-ffloat-primops-ok',
815 # '-fdo-eta-reduction',
816 '-fdo-lambda-eta-expansion', # After full laziness
818 $Oopt_PedanticBottoms,
819 $Oopt_MonadEtaExpansion,
820 $Oopt_UnfoldingUseThreshold,
821 $Oopt_MaxSimplifierIterations,
822 $Oopt_ShowSimplifierProgress,
831 '-ffloat-lets-exposing-whnf',
832 '-ffloat-primops-ok',
836 '-fdo-eta-reduction',
837 '-fdo-lambda-eta-expansion',
839 ($Oopt_FoldrBuildInline),
840 # you need to inline foldr and build
841 ($Oopt_FoldrBuild) ? ('-fdo-foldr-build') : (),
842 # but do reductions if you see them!
843 $Oopt_PedanticBottoms,
844 $Oopt_MonadEtaExpansion,
845 $Oopt_UnfoldingUseThreshold,
846 $Oopt_MaxSimplifierIterations,
847 $Oopt_ShowSimplifierProgress,
855 '-ffloat-lets-exposing-whnf',
856 '-ffloat-primops-ok',
860 # '-fdo-eta-reduction',
861 '-fdo-lambda-eta-expansion',
863 '-flet-to-case', # Aha! Only done after strictness analysis
864 $Oopt_PedanticBottoms,
865 $Oopt_MonadEtaExpansion,
866 $Oopt_UnfoldingUseThreshold,
867 $Oopt_MaxSimplifierIterations,
868 $Oopt_ShowSimplifierProgress,
873 # Case-liberation for -O2. This should be after
874 # strictness analysis and the simplification which follows it.
878 # : "-fliberate-case -fsimplify [ $Oopt_FB_Support -ffloat-lets-exposing-whnf -ffloat-primops-ok -fcase-of-case -fdo-case-elim -fcase-merge -fdo-eta-reduction -fdo-lambda-eta-expansion -freuse-con -flet-to-case $Oopt_PedanticBottoms $Oopt_MonadEtaExpansion $Oopt_UnfoldingUseThreshold $Oopt_MaxSimplifierIterations $Oopt_ShowSimplifierProgress ]" ),
880 # Final clean-up simplification:
885 '-ffloat-lets-exposing-whnf',
886 '-ffloat-primops-ok',
890 # '-fdo-eta-reduction',
891 '-fdo-lambda-eta-expansion',
894 '-fignore-inline-pragma', # **** NB!
895 $Oopt_FoldrBuildInline,
896 ($Oopt_FoldrBuild) ? ('-fdo-foldr-build') : (),
897 # but still do reductions if you see them!
898 $Oopt_PedanticBottoms,
899 $Oopt_MonadEtaExpansion,
900 $Oopt_UnfoldingUseThreshold,
901 $Oopt_MaxSimplifierIterations,
902 $Oopt_ShowSimplifierProgress,
907 #LATER: '-fcalc-inlinings2', -- pointless for 2.01
912 $Oopt_FinalStgProfilingMassage,
918 # SPECIAL FLAGS for -O2
926 Sort out what we're going to do about optimising. First, the @hsc@
927 flags and regular @cc@ flags to worry about:
929 if ( $OptLevel <= 0 ) {
931 # for this level, we tell the parser -fignore-interface-pragmas
932 push(@HsC_flags, '-fignore-interface-pragmas');
933 # and tell the compiler not to produce them
934 push(@HsC_flags, '-fomit-interface-pragmas');
936 &add_Hsc_flags( @HsC_minusNoO_flags );
937 push(@CcBoth_flags, ($MinusO2ForC) ? '-O2' : '-O'); # not optional!
939 } elsif ( $OptLevel == 1 || $OptLevel == 2 ) {
941 &add_Hsc_flags( @HsC_minusO_flags );
942 push(@CcBoth_flags, ($MinusO2ForC || $OptLevel == 2) ? '-O2' : '-O'); # not optional!
943 # -O? to GCC is not optional! -O2 probably isn't worth it generally,
944 # but it *is* useful in compiling the garbage collectors (so said
945 # Patrick many moons ago...).
947 } else { # -Ofile, then...
949 &add_Hsc_flags( @HsC_minusO3_flags );
950 push(@HsC_flags, $Oopt_FinalStgProfilingMassage) if $Oopt_FinalStgProfilingMassage;
952 push(@CcBoth_flags, ($MinusO2ForC) ? '-O2' : '-O'); # possibly to be elaborated...
955 } # setupOptimiseFlags
959 %************************************************************************
961 \subsection{Check for consistency, etc.}
963 %************************************************************************
965 Sort out @$BuildTag@, @$PROFing@, @$CONCURing@, @$PARing@,
966 @$GRANing@, @$TICKYing@:
968 sub setupBuildFlags {
971 # PROFILING stuff after argv mangling:
973 # warn about any scc exprs found (in case scc used as identifier)
974 push(@HsP_flags, '-W');
976 # add -auto sccs even if not profiling !
977 push(@HsC_flags, $UNPROFscc_auto) if $UNPROFscc_auto;
980 push(@HsC_flags, $PROFauto) if $PROFauto;
981 push(@HsC_flags, $PROFcaf) if $PROFcaf;
982 #push(@HsC_flags, $PROFdict) if $PROFdict;
984 $Oopt_FinalStgProfilingMassage = '-fmassage-stg-for-profiling';
986 push(@HsP_flags, (($PROFignore_scc) ? $PROFignore_scc : '-S'));
988 if ( $SplitObjFiles ) {
989 # can't split with cost centres -- would need global and externs
990 print STDERR "$Pgm: WARNING: splitting objects when profiling will *BREAK* if any _scc_s are present!\n";
991 # (but it's fine if there aren't any _scc_s around...)
992 # $SplitObjFiles = 0; # unset
993 #not an error: for now: $Status++;
996 #if ( $BuildTag ne '' ) {
997 # local($b) = $BuildDescr{$BuildTag};
998 # if ($CONCURing eq 'c') { print STDERR "$Pgm: Can't mix $b with -concurrent.\n"; exit 1; }
999 # if ($PARing eq 'p') { print STDERR "$Pgm: Can't mix $b with -parallel.\n"; exit 1; }
1000 # if ($GRANing eq 'g') { print STDERR "$Pgm: Can't mix $b with -gransim.\n"; exit 1; }
1001 # if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix $b with -ticky.\n"; exit 1; }
1003 # # ok to have a user-way profiling build
1004 # # eval the profiling opts ... but leave user-way BuildTag
1005 # if ($PROFing eq 'p') { &processArgs(split(' ', $SetupOpts{'_p'})); } # eval($EvaldSetupOpts{'_p'}); }
1007 if ( $PROFing eq 'p' ) {
1008 if ($PARing eq 'p') { print STDERR "$Pgm: Can't do profiling with -parallel.\n"; exit 1; }
1009 if ($GRANing eq 'g') { print STDERR "$Pgm: Can't do profiling with -gransim.\n"; exit 1; }
1010 if ($TICKYing eq 't') { print STDERR "$Pgm: Can't do profiling with -ticky.\n"; exit 1; }
1011 $BuildTag = ($CONCURing eq 'c') ? '_mr' : '_p' ; # possibly "profiled concurrent"...
1013 } elsif ( $CONCURing eq 'c' ) {
1014 if ($PARing eq 'p') { print STDERR "$Pgm: Can't mix -concurrent with -parallel.\n"; exit 1; }
1015 if ($GRANing eq 'g') { print STDERR "$Pgm: Can't mix -concurrent with -gransim.\n"; exit 1; }
1016 $BuildTag = ($TICKYing eq 't') ? '_mt' : '_mc' ; # possibly "ticky concurrent"...
1017 # "profiled concurrent" already acct'd for...
1019 } elsif ( $PARing eq 'p' ) {
1020 if ($GRANing eq 'g') { print STDERR "$Pgm: Can't mix -parallel with -gransim.\n"; exit 1; }
1021 if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix -parallel with -ticky.\n"; exit 1; }
1024 if ( $Do_lnkr && ( ! $ENV{'PVM_ROOT'} || ! $ENV{'PVM_ARCH'} )) {
1025 print STDERR "$Pgm: both your PVM_ROOT and PVM_ARCH environment variables must be set for linking under -parallel.\n";
1029 } elsif ( $GRANing eq 'g' ) {
1030 if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix -gransim with -ticky.\n"; exit 1; }
1033 } elsif ( $TICKYing eq 't' ) {
1039 After the sanity checks, add flags to the necessary parts of the driver pipeline:
1042 if ( $BuildTag ne '' ) { # something other than normal sequential...
1044 local($Tag) = "${BuildTag}";
1045 $Tag =~ s/_//; # move the underscore to the back
1047 $HscOut = '-C='; # must go via C
1048 &processArgs(split(' ', $SetupOpts{$BuildTag}));
1049 # eval($EvaldSetupOpts{$BuildTag});
1053 Decide what the consistency-checking options are in force for this run:
1056 $HsC_consist_options = "${BuildTag},${DEBUGging}";
1057 $Cc_consist_options = "${BuildTag},${DEBUGging}";
1060 # Funny place to put it, but why not.
1062 if ( $HiSuffix_prelude eq '' ) {
1063 local($Tag) = "${BuildTag}";
1065 $Tag = "${Tag}_" if $Tag ne '';
1066 $HiSuffix_prelude="${Tag}hi";
1068 #push(@HsC_flags, "-hisuf-prelude=.${HiSuffix_prelude}"); # use appropriate Prelude .hi files
1069 #push(@HsC_flags, "-hisuf=.${HiSuffix}");
1074 %************************************************************************
1076 \subsection{Add on machine-specific C-compiler flags}
1078 %************************************************************************
1080 Shove on magical machine-specific options. We use \tr{unshift} to
1081 stick them on the {\em front} of the arrays, so that ``later''
1082 user-specified flags can clobber them (e.g., \tr{-U__STG_REV_TBLS__}).
1084 Note: a few ``always apply'' flags were set at the very beginning.
1089 if ($TargetPlatform =~ /^alpha-/) {
1090 # we know how to *mangle* asm for alpha
1091 unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1092 unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK;
1093 unshift(@CcBoth_flags, ('-static'));
1095 } elsif ($TargetPlatform =~ /^hppa/) {
1096 # we know how to *mangle* asm for hppa
1097 unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1098 unshift(@CcBoth_flags, ('-static'));
1100 # We don't put in '-mlong-calls', because it's only
1101 # needed for very big modules (sigh), and we don't want
1102 # to hobble ourselves further on all the other modules
1105 # [Dated comment (gcc-2.6.x?), -mlong-calls is no longer
1106 # a supported gcc HPPA flag]
1107 unshift(@CcBoth_flags, ('-D_HPUX_SOURCE'));
1108 # ___HPUX_SOURCE, not _HPUX_SOURCE, is #defined if -ansi!
1109 # (very nice, but too bad the HP /usr/include files don't agree.)
1111 } elsif ($TargetPlatform =~ /^i386-/) {
1112 # we know how to *mangle* asm for X86
1113 unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1114 unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK && $TargetPlatform !~ /nextstep/;
1115 # I do not know how to do STACK_CHECK_BY_PAGE_FAULT
1116 # on NeXTs (my fault, not theirs), so I don't.
1119 # -fno-defer-pop : basically the same game as for m68k
1121 # -fomit-frame-pointer : *must* ; because we're stealing
1122 # the fp (%ebp) for our register maps. *All* register
1123 # maps (in MachRegs.lh) must steal it.
1125 unshift(@CcRegd_flags_hc, '-fno-defer-pop');
1126 unshift(@CcRegd_flags, '-fomit-frame-pointer');
1127 unshift(@CcRegd_flags, "-DSTOLEN_X86_REGS=$StolenX86Regs");
1129 } elsif ($TargetPlatform =~ /^m68k-/) {
1130 # we know how to *mangle* asm for m68k
1131 unshift (@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1132 unshift (@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK && $TargetPlatform !~ /nextstep/;
1133 # I do not know how to do STACK_CHECK_BY_PAGE_FAULT
1134 # on NeXTs (my fault, not theirs), so I don't.
1137 # -fno-defer-pop : for the .hc files, we want all the pushing/
1138 # popping of args to routines to be explicit; if we let things
1139 # be deferred 'til after an STGJUMP, imminent death is certain!
1141 # -fomit-frame-pointer : *don't*
1142 # It's better to have a6 completely tied up being a frame pointer
1143 # rather than let GCC pick random things to do with it.
1144 # (If we want to steal a6, then we would try to do things
1145 # as on iX86, where we *do* steal the frame pointer [%ebp].)
1147 unshift(@CcRegd_flags_hc, '-fno-defer-pop');
1148 unshift(@CcRegd_flags, '-fno-omit-frame-pointer');
1149 # maybe gives reg alloc a better time
1150 # also: -fno-defer-pop is not sufficiently well-behaved without it
1152 } elsif ($TargetPlatform =~ /^mips-/) {
1153 # we (hope to) know how to *mangle* asm for MIPSen
1154 unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1155 unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK;
1156 unshift(@CcBoth_flags, ('-static'));
1158 } elsif ($TargetPlatform =~ /^powerpc-|^rs6000-/) {
1159 # we know how to *mangle* asm for PowerPC
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')); # always easier to start with
1163 unshift(@CcRegd_flags, ('-finhibit-size-directive')); # avoids traceback tables
1164 } elsif ($TargetPlatform =~ /^sparc-/) {
1165 # we know how to *mangle* asm for SPARC
1166 unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1167 unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK;
1170 } # end of setupMachOpts
1173 %************************************************************************
1175 \subsection{Set up for warnings}
1177 %************************************************************************
1179 Several warnings are turned on by default. These are supposed to be
1180 the 'I'm pretty sure you've made a mistake here' kind of warnings.
1181 The rest are turned on by the -W and -Wall options, or individually
1182 via their -fwarn and -fno-warn flags.
1185 sub setupWarningFlags {
1186 &add_Hsc_flags( @StandardWarnings );
1190 Same unshifting magic, but for special linker flags.
1192 The configure script determines whether the object file symbol tables
1193 have a leading underscore, and sets @LeadingUnderscore@ accordingly.
1194 (The driver script `sees' the setting of the @LeadingUnderscore@
1195 by having the Makefile prepend it).
1199 local($uscore) = ( ${LeadingUnderscore} eq 'YES' ) ? '_' : '';
1202 (($Ld_main) ? ( '-u', "${uscore}Main_" . $Ld_main . '_closure' ) : ()));
1204 ( '-u', "${uscore}PrelBase_Z91Z93_closure" # i.e., []
1205 ,'-u', "${uscore}PrelBase_IZh_static_info"
1206 ,'-u', "${uscore}PrelBase_CZh_static_info"
1207 ,'-u', "${uscore}PrelBase_False_inregs_info"
1208 ,'-u', "${uscore}PrelBase_True_inregs_info"
1209 ,'-u', "${uscore}DEBUG_REGS"
1211 if ($TargetPlatform =~ /^powerpc-|^rs6000-/) {
1212 # sometimes we have lots of toc entries...
1213 # unshift(@Ld_flags, ('-Xlinker -bbigtoc -Xlinker -bnoquiet'));
1214 unshift(@Ld_flags, ('-Xlinker -bbigtoc'));
1217 } # end of setupLinkOpts
1221 %************************************************************************
1223 \subsection{Set up include paths and system-library enslurpment}
1225 %************************************************************************
1227 Now that we know what garbage-collector, etc., are required, we can
1228 finalise our list of libraries to slurp through, and generally Get
1233 # default includes must be added AFTER option processing
1234 if ( ! $INSTALLING ) {
1235 push (@Include_dir, "$TopPwd/${CURRENT_DIR}/${GHC_INCLUDE_DIR}");
1237 push (@Include_dir, "$InstLibDirGhc/includes");
1238 push (@Include_dir, "$InstLibDirGhc/includes");
1240 } # end of setupIncPaths
1245 push(@SysLibrary, ( '-lHS', '-lHS_cbits' )); # basic I/O and prelude stuff
1248 foreach $f (@SysLibrary) {
1249 next if $f =~ /_cbits/;
1250 $f .= $BuildTag if $f =~ /^-lHS/;
1253 # fiddle the TopClosure file name...
1254 $TopClosureFile =~ s/XXXX//;
1256 # Push library HSrts, plus boring clib bit
1257 push(@SysLibrary, "-lHSrts${BuildTag}");
1258 push(@SysLibrary, '-lHSclib');
1260 # RTS compiled with cygwin32, uses the WinMM API
1261 # to implement the itimers, since cygwin.dll does not
1262 # support it. Only reqd. for `ways' that use itimers.
1264 push(@SysLibrary, '-lwinmm') if $BuildTag ne '' && $TargetPlatform eq 'i386-unknown-cygwin32';
1266 # Push the pvm libraries
1267 if ($BuildTag eq '_mp') {
1268 $pvmlib = "$ENV{'PVM_ROOT'}/lib/$ENV{'PVM_ARCH'}";
1269 push(@SysLibrary, "-L$pvmlib", '-lpvm3', '-lgpvm3');
1270 if ( $ENV{'PVM_ARCH'} eq 'SUNMP' ) {
1271 push(@SysLibrary, '-lthread', '-lsocket', '-lnsl');
1272 } elsif ( $ENV{'PVM_ARCH'} eq 'SUN4SOL2' ) {
1273 push(@SysLibrary, '-lsocket', '-lnsl');
1277 # Push the GNU multi-precision arith lib; and the math library
1278 push(@SysLibrary, '-lgmp');
1279 push(@SysLibrary, '-lm');
1282 %************************************************************************
1284 \subsection{Check that this system was built to do what we are asking}
1286 %************************************************************************
1288 Before continuing we check that the appropriate build is available.
1291 #die "$Pgm: no BuildAvail?? $BuildTag\n" if $BuildDescr{$BuildTag} eq '' ; # sanity
1293 if ( $BuildDescr{$BuildTag} eq '' ) {
1294 print STDERR "$Pgm: a `", $BuildDescr{$BuildTag},
1295 "' \"build\" is not available with your GHC setup.\n";
1296 print STDERR "(It was not configured for it at your site.)\n";
1297 print STDERR $ShortUsage;
1301 } # end of setupSyslibs
1305 %************************************************************************
1307 \subsection{Final miscellaneous setup bits before we start going}
1309 %************************************************************************
1311 Record largest specific heapsize, if any.
1313 sub setupHeapStackSize {
1314 $Specific_heap_size = $Specific_heap_size * $Scale_sizes_by;
1315 push(@HsC_rts_flags, '-H'.$Specific_heap_size);
1316 $Specific_stk_size = $Specific_stk_size * $Scale_sizes_by;
1317 push(@HsC_rts_flags, "-K$Specific_stk_size");
1321 If no input or link files seen, then we let 'em feed in stdin; this is
1322 mainly for debugging.
1326 if ($#Input_file < 0 && $#Link_file < 0) {
1327 @Input_file = ( '-' );
1329 open(INF, "> $Tmp_prefix.hs") || &tidy_up_and_die(1,"Can't open $Tmp_prefix.hs\n");
1330 print STDERR "Enter your Haskell program, end with ^D (on a line of its own):\n" if -t;
1331 while (<STDIN>) { print INF $_; }
1332 close(INF) || &tidy_up_and_die(1,"Failed writing to $Tmp_prefix.hs\n");
1337 Tell the world who we are, if they asked.
1339 print STDERR "${PROJECTNAME}, version ${PROJECTVERSION}, patchlevel ${PROJECTPATCHLEVEL}\n"
1343 %************************************************************************
1345 \section[Driver-main-loop]{Main loop: Process input files, and link if required}
1347 %************************************************************************
1349 Process the input files; don't continue with linking if there are
1350 problems (global variable @$Status@ non-zero).
1352 foreach $ifile (@Input_file) {
1353 &ProcessInputFile($ifile);
1356 if ( $Status > 0 ) { # don't link if there were errors...
1357 print STDERR $ShortUsage;
1362 # append last minute flags linker and consistency flags
1369 Link if appropriate.
1372 local($libdirs) = '';
1374 # glue them together:
1375 push(@UserLibrary_dir, @SysLibrary_dir);
1377 $libdirs = '-L' . join(' -L',@UserLibrary_dir) if $#UserLibrary_dir >= 0;
1379 # for a linker, use an explicitly given one, or the going C compiler ...
1380 local($lnkr) = ( $Lnkr ) ? $Lnkr : $CcRegd;
1382 local($output) = ($Specific_output_file ne '') ? "-o $Specific_output_file" : '';
1383 @Files_to_tidy = ($Specific_output_file ne '') ? $Specific_output_file : 'a.out';
1385 local($to_do) = "$lnkr $Verbose @Ld_flags $output @Link_file $TopClosureFile $libdirs @UserLibrary @SysLibrary";
1386 &run_something($to_do, 'Linker');
1388 # finally, check the consistency info in the binary
1389 local($executable) = $Files_to_tidy[0];
1390 @Files_to_tidy = (); # reset; we don't want to nuke it if it's inconsistent
1393 # dynamically load consistency-chking code; then do it.
1394 require('ghc-consist.prl')
1395 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-consist.prl!\n");
1397 &chk_consistency_info ( $executable );
1400 # if PVM parallel stuff, we do truly weird things.
1401 # Essentially: (1) move the executable over to where PVM expects
1402 # to find it. (2) create a script in place of the executable
1403 # which will cause the program to be run, via SysMan.
1404 if ( $PARing eq 'p' ) {
1405 local($pvm_executable) = $executable;
1406 local($pvm_executable_base);
1408 if ( $pvm_executable !~ /^\// ) { # a relative path name: make absolute
1409 local($pwd) = `pwd`;
1411 $pwd =~ s/^\/tmp_mnt//;
1412 $pvm_executable = "$pwd/$pvm_executable";
1415 $pvm_executable =~ s|/|=|g; # make /s into =s
1416 $pvm_executable_base = $pvm_executable;
1418 $pvm_executable = $ENV{'PVM_ROOT'} . '/bin/' . $ENV{'PVM_ARCH'}
1419 . "/$pvm_executable";
1421 &run_something("$Rm -f $pvm_executable; $Cp -p $executable $pvm_executable && $Rm -f $executable", 'Moving binary to PVM land');
1423 # OK, now create the magic script for "$executable"
1424 open(EXEC, "> $executable") || &tidy_up_and_die(1,"$Pgm: couldn't open $executable to write!\n");
1425 print EXEC <<EOSCRIPT1;
1426 eval 'exec perl -S \$0 \${1+"\$@"}'
1427 if \$running_under_some_shell;
1428 # =!=!=!=!=!=!=!=!=!=!=!
1429 # This script is automatically generated: DO NOT EDIT!!!
1430 # Generated by Glasgow Haskell, version ${PROJECTVERSION} ${PROJECTPATCHLEVEL}
1432 \$pvm_executable = '$pvm_executable';
1433 \$pvm_executable_base = '$pvm_executable_base';
1434 \$SysMan = '$SysMan';
1437 print EXEC <<\EOSCRIPT2;
1438 # first, some magical shortcuts to run "commands" on the binary
1440 if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {
1442 system("$cmd $pvm_executable");
1446 # OK, really run it; process the args first
1447 $ENV{'PE'} = $pvm_executable_base;
1449 $nprocessors = 2; # the default
1453 # ToDo: handle --RTS
1454 args: while ($a = shift(@ARGV)) {
1455 if ( $a eq '+RTS' ) {
1457 } elsif ( $a eq '-RTS' ) {
1460 if ( $a eq '-d' && $in_RTS_args ) {
1462 } elsif ( $a =~ /^-N(\d+)/ && $in_RTS_args ) {
1465 push(@nonPVM_args, $a);
1469 local($return_val) = 0;
1470 system("$SysMan $debug $pvm_executable $nprocessors @nonPVM_args");
1472 system("mv $ENV{'HOME'}/$pvm_executable_base.???.gr .") if -f "$ENV{'HOME'}/$pvm_executable_base.001.gr";
1475 close(EXEC) || die "Failed closing $executable\n";
1476 chmod 0755, $executable;
1480 # that... that's all, folks!
1482 exit $Status; # will still be 0 if all went well
1485 %************************************************************************
1487 \section[Driver-do-one-file]{How to process a single input file}
1489 %************************************************************************
1492 sub ProcessInputFile {
1493 local($ifile) = @_; # input file name
1494 local($ifile_root); # root of or basename of input file
1495 local($ofile_target); # ultimate output file we hope to produce
1496 # from input file (need to know for recomp
1497 # checking purposes)
1498 local($hifile_target);# ditto (but .hi file)
1501 Handle the weirdity of input from stdin.
1503 if ($ifile ne '-') {
1504 ($ifile_root = $ifile) =~ s/\.[^\.\/]+$//;
1505 $ofile_target = # may be reset later...
1506 ($Specific_output_file ne '' && ! $Do_lnkr)
1507 ? $Specific_output_file
1508 : &odir_ify($ifile_root, 'o');
1509 $hifile_target= ($Specific_hi_file ne '')
1511 : "$ifile_root.$HiSuffix"; # ToDo: odirify?
1512 # NB: may change if $ifile_root isn't module name (??)
1514 $ifile = "$Tmp_prefix.hs"; # we know that's where we put the input
1515 $ifile_root = '_stdin';
1516 $ofile_target = '_stdout'; # gratuitous?
1517 $hifile_target= '_stdout'; # ditto?
1521 We need to decide what phases of the compilation system we will run
1522 over this file. The defaults are the ones established when processing
1523 flags. (That established what the last phase run for all files is.)
1525 We do the pre-recompilation-checker phases here; the rest later.
1529 Look at the suffix and decide what initial phases of compilation may
1530 be dropped off for this file. Also the rather boring business of
1531 which files are coming-in/going-out.
1533 Again, we'll do the post-recompilation-checker parts of this later.
1535 local($do_lit2pgm) = ($ifile =~ /\.lhs$/) ? 1 : 0;
1536 local($do_hscpp) = 1; # but "hscpp" might really be "cat"
1539 # names of the files to stuff between phases
1540 # defaults are temporaries
1541 local($in_lit2pgm) = $ifile;
1542 local($lit2pgm_hscpp) = "$Tmp_prefix.lpp";
1543 local($hscpp_hsc) = "$Tmp_prefix.cpp";
1544 local($hsc_hi) = "$Tmp_prefix.hi";
1545 local($cc_as_o) = "${Tmp_prefix}_o.s"; # temporary for raw .s file if opt C
1546 local($cc_as) = "$Tmp_prefix.s"; # mangled or hsc-produced .s code
1547 local($as_out) = $ofile_target;
1549 local($is_hc_file) = 1; #Is the C code .hc or .c? Assume .hc for now
1551 # OK, let's strip off some literate junk..
1553 &runLit2pgm($in_lit2pgm, $lit2pgm_hscpp)
1555 $lit2pgm_hscpp = $ifile;
1561 # Scan the top of the de-litted file for {-# OPTIONS #-} pragmas
1562 &check_for_source_options($lit2pgm_hscpp,$ifile);
1564 # Options found in the source file take a back seat, i.e., we scan
1565 # them first. Only process the command line again if source file
1566 # contained anything of interest *or* there's more than one
1567 # input file (we have to reset the options).
1569 if ( $#Input_file >= 0 || $#File_options >= 0) {
1570 #@File_options = (@File_options, @Cmd_opts);
1572 # Now process the command line
1573 &initDriverGlobals();
1574 &processArgs((@File_options,@Cmd_opts));
1575 print STDERR "\nEffective command line: " .
1576 join(' ',(@File_options,@Cmd_opts)) . "\n" if $Verbose;
1579 # Having got the effective command line scanned, set up
1580 # the various options in prep for some real work.
1582 # check the sanity of the BuildTag we're about to use,
1583 # and if needs be, add some more flags and setup to
1584 # the different phases.
1587 &setupOptimiseFlags();
1590 &setupWarningFlags();
1591 &setupHeapStackSize();
1594 # These two variables need to be set after the
1595 # command-line has been processed and the build options
1596 # have be seen set up. This is because command-line options
1597 # can control whether to compile vias C or not.
1599 local($do_cc) = ( $Do_cc != -1) # i.e., it was set explicitly
1601 : ( ($HscOut eq '-C=') ? 1 : 0 );
1602 local($do_as) = $Do_as;
1603 local($hsc_out) = ( $HscOut eq '-C=' ) ? "$Tmp_prefix.hc" : "$Tmp_prefix.s" ;
1605 if ($Only_preprocess_hc) { # stop after having run $Cc -E
1608 if ($Only_preprocess_C) { # stop after having run $hscpp
1609 $do_hsc=0; $do_cc = 0; $do_as=0;
1610 } elsif ($ifile =~ /.lhs$/ || $ifile =~ /.hs$/ ) {
1612 } elsif ($ifile =~ /\.hc$/ || $ifile =~ /_hc$/ ) { # || $ifile =~ /\.$Isuffix$/o) # ToDo: better
1613 $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
1615 } elsif ($ifile =~ /\.c$/) {
1616 $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
1617 $hsc_out = $ifile; $is_hc_file = 0;
1618 } elsif ($ifile =~ /\.s$/) {
1619 $do_hscpp = 0; $do_hsc = 0; $do_cc = 0;
1621 } else { # don't know what it is, but nothing to do herein...
1622 $do_hscpp = 0; $do_hsc = 0; $do_cc = 0; $do_as = 0;
1625 # hack to avoid running hscpp
1626 $HsCpp = $Cat if ! $Cpp_flag_set;
1628 &runHscpp($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc) if $do_hscpp;
1632 We now think about whether to run hsc/cc or not (when hsc produces .s
1633 stuff, it effectively takes the place of both phases).
1635 To get the output file name right: for each phase that we are {\em
1636 not} going to run, set its input (i.e., the output of its preceding
1637 phase) to @"$ifile_root.<suffix>"@.
1640 local($going_interactive) = $HscOut eq '-N=' || $ifile_root eq '_stdin';
1643 # Warning issued if -keep-hc-file-too is used without
1644 # -fvia-C (or the equivalent)
1646 if ( $HscOut ne '-C=' && $Keep_hc_file_too ) {
1647 print STDERR "$Pgm: warning: Native code generator to be used, -keep-hc-file-too will be ignored\n";
1650 if (! $do_cc && ! $do_as) { # stopping after hsc
1651 $hsc_out = ($Specific_output_file ne '')
1652 ? $Specific_output_file
1653 : &odir_ify($ifile_root, ($HscOut eq '-C=') ? 'hc' : 's');
1655 $ofile_target = $hsc_out; # reset
1658 if (! $do_as) { # stopping after gcc (or hsc)
1659 $cc_as = ($Specific_output_file ne '')
1660 ? $Specific_output_file
1661 : &odir_ify($ifile_root, ( $Only_preprocess_hc ) ? 'i' : 's');
1663 $ofile_target = $cc_as; # reset
1669 Now the Haskell compiler, C compiler, and assembler
1673 &runHscAndProcessInterfaces( $ifile, $hscpp_hsc, $ifile_root,
1674 $ofile_target, $hifile_target);
1678 &runGcc ($is_hc_file, $hsc_out, $cc_as_o);
1679 &runMangler($is_hc_file, $cc_as_o, $cc_as, $ifile_root) if ! $Only_preprocess_hc;
1682 &split_asm_file($cc_as) if $do_as && $SplitObjFiles;
1684 # save a copy of the .s file..
1685 &saveIntermediate($ifile_root , "s" , $cc_as) if ($do_as && $Keep_s_file_too);
1686 &runAs($as_out, $ifile_root) if $do_as;
1689 Finally, decide what to queue up for linker input.
1691 # tentatively assume we will eventually produce linker input:
1692 push(@Link_file, &odir_ify($ifile_root, 'o'));
1694 #ToDo: local($or_isuf) = ($Isuffix eq '') ? '' : "|$Isuffix";
1696 if ( $ifile !~ /\.(lhs|hs|hc|c|s)$/ && $ifile !~ /_hc$/ ) {
1697 print STDERR "$Pgm: don't recognise suffix on `$ifile'; passing it through to linker\n"
1698 if $ifile !~ /\.a$/;
1700 # oops; we tentatively pushed the wrong thing; fix & do the right thing
1701 pop(@Link_file); push(@Link_file, $ifile);
1705 } # end of ProcessInputFile
1708 %************************************************************************
1710 \section[Driver-run-phases]{Routines to run the various phases}
1712 %************************************************************************
1716 local($in_lit2pgm, $lit2pgm_hscpp) = @_;
1720 # Only add #line pragma if we're going to need it.
1721 $to_do = "echo '#line 1 \"$in_lit2pgm\"' > $lit2pgm_hscpp && " if ($Cpp_flag_set);
1722 $to_do .= "$Unlit @Unlit_flags $in_lit2pgm - >> $lit2pgm_hscpp";
1724 push(@Files_to_tidy, $lit2pgm_hscpp );
1726 &run_something($to_do, 'literate pre-processor');
1732 local($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc) = @_;
1736 # Strictly speaking, echoing of the following line pragma is only required
1737 # on non-delit'ed input, as we've already added it during de-lit. However,
1738 # hscpp will then add a {-# LINE 1 "$lit2pgm_hsc" -} to the top of the file,
1739 # which is not very informative (but harmless). Hence, we uniformly have
1740 # {-# LINE 1 "$in_lit2pgm" #-} as the first line to all cpp'ed hsc input.
1742 $to_do = "echo '{-# LINE 1 \"$in_lit2pgm\" -}' > $hscpp_hsc && ";
1744 if ($HsCpp eq $Cat) {
1745 $to_do .= "$HsCpp $lit2pgm_hscpp >> $hscpp_hsc";
1746 push(@Files_to_tidy, $hscpp_hsc );
1747 &run_something($to_do, 'Ineffective C pre-processor');
1749 local($includes) = '-I' . join(' -I',@Include_dir);
1750 $to_do .= "$HsCpp $Verbose $genSPECS_flag @HsCpp_flags -D__HASKELL1__=$Haskell1Version -D__GLASGOW_HASKELL__=$GhcVersionInfo $includes $lit2pgm_hscpp >> $hscpp_hsc";
1751 push(@Files_to_tidy, $hscpp_hsc );
1752 &run_something($to_do, 'Haskellised C pre-processor');
1755 if ( $Only_preprocess_C ) {
1756 $to_do = "$Cat $hscpp_hsc";
1757 &run_something($to_do, '');
1765 sub runHscAndProcessInterfaces {
1766 local($ifile, $hscpp_hsc, $ifile_root, $ofile_target, $hifile_target) = @_;
1768 # $ifile is the original input file
1769 # $hscpp_hsc post-unlit, post-cpp, etc., input file
1770 # $ifile_root input filename minus suffix
1771 # $ofile_target the output file that we ultimately hope to produce
1772 # $hifile_target the .hi file ... (ditto)
1774 local($source_unchanged) = 1;
1776 # Check if the source file is up to date relative to the target; in
1777 # that case we say "source is unchanged" and let the compiler bail out
1778 # early if the import usage information allows it.
1780 ($i_dev,$i_ino,$i_mode,$i_nlink,$i_uid,$i_gid,$i_rdev,$i_size,
1781 $i_atime,$i_mtime,$i_ctime,$i_blksize,$i_blocks) = stat($ifile);
1783 # The informational messages below are now conditional on -v being set -- SOF
1784 if ( $ofile_target ne "_stdin.s" && ! -f $ofile_target ) {
1785 print STDERR "$Pgm:compile:Output file $ofile_target doesn't exist\n" if $Verbose;
1786 $source_unchanged = 0;
1789 ($o_dev,$o_ino,$o_mode,$o_nlink,$o_uid,$o_gid,$o_rdev,$o_size,
1790 $o_atime,$o_mtime,$o_ctime,$o_blksize,$o_blocks) = stat(_); # stat info from -f test
1792 if ( $hifile_target ne "_stdout" && ! -f $hifile_target ) {
1793 print STDERR "$Pgm:compile:Interface file $hifile_target doesn't exist\n" if $Verbose;
1794 $source_unchanged = 0;
1797 ($hi_dev,$hi_ino,$hi_mode,$hi_nlink,$hi_uid,$hi_gid,$hi_rdev,$hi_size,
1798 $hi_atime,$hi_mtime,$hi_ctime,$hi_blksize,$hi_blocks) = stat(_); # stat info from -f test
1800 if ( $ofile_target ne "_stdin.s" && $i_mtime > $o_mtime) {
1801 print STDERR "$Pgm:recompile:Input file $ifile newer than $ofile_target\n" if $Verbose;
1802 $source_unchanged = 0;
1805 # So if source_unchanged is still "1", we pass on the good news to the compiler
1806 # The -recomp flag can disable this, forcing recompilation
1807 if ($Do_recomp_chkr && $source_unchanged) {
1808 push(@HsC_flags, '-fsource-unchanged');
1813 &runHsc($ifile_root, $hsc_out, $hsc_hi, $going_interactive);
1815 # See if it bailed out early, saying nothing needed doing.
1816 # We work this out by seeing if it created an output .hi file
1818 if ( ! -f $hsc_hi && $ProduceHi !~ /-nohifile=/ ) {
1819 # Doesn't exist, so we bailed out early.
1820 # Tell the C compiler and assembler not to run
1821 $do_cc = 0; $do_as = 0;
1823 # Update dependency info, touch both object file and
1824 # interface file, so that the following invariant is
1827 # a dependent module's interface file should after recompilation
1828 # checking be newer than the interface files of its imports.
1830 # That is, if module A's interface file changes, then module B
1831 # (which import from A) needs to be checked.
1832 # If A's change does not affect B, which causes the compiler to bail
1833 # out early, we still need to touch the interface file of B. The reason
1834 # for this is that B may export A's interface.
1836 &run_something("touch $ofile_target",
1837 "Touch $ofile_target, to propagate dependencies") if $HscOut ne '-N=';
1838 &run_something("touch $hifile_target",
1839 "Touch $hifile_target, to propagate dependencies") if $ProduceHi =~ /-nohifile=/ ;
1843 # Didn't bail out early (new .hi file) so we thunder on
1845 # If non-interactive, heave in the consistency info at the end
1846 # NB: pretty hackish (depends on how $output is set)
1847 if ( ! $going_interactive ) {
1848 if ( $HscOut eq '-C=' ) {
1849 $to_do = "echo 'static char ghc_hsc_ID[] = \"\@(#)hsc $ifile\t$HsC_major_version.$HsC_minor_version,$HsC_consist_options\";' >> $hsc_out";
1851 } elsif ( $HscOut eq '-S=' ) {
1852 local($consist) = "hsc.$ifile.$HsC_major_version.$HsC_minor_version.$HsC_consist_options";
1853 $consist =~ s/,/./g;
1854 $consist =~ s/\//./g;
1855 $consist =~ s/-/_/g;
1856 $consist =~ s/[^A-Za-z0-9_.]/ZZ/g; # ToDo: properly?
1857 $to_do = "echo '\n\t.text\n$consist:' >> $hsc_out";
1859 &run_something($to_do, 'Pin on Haskell consistency info');
1863 # Interface-handling is important enough to live off by itself
1864 if ( $ProduceHi !~ /-nohifile=/ ) { # If we've produced one, process it.
1865 require('ghc-iface.prl') || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-iface.prl!\n");
1866 &postprocessHiFile($hsc_hi, $hifile_target, $going_interactive);
1868 # if we're going to split up object files,
1869 # we inject split markers into the .hc file now
1870 if ( $HscOut eq '-C=' && $SplitObjFiles ) {
1871 &inject_split_markers ( $hsc_out );
1874 # save a copy of the .hc file, even if we are carrying on...
1875 if ($HscOut eq '-C=' && $do_cc && $Keep_hc_file_too) {
1876 &saveIntermediate($ifile_root , "hc" , $hsc_out);
1886 local($ifile_root, $hsc_out, $hsc_hi, $going_interactive) = @_;
1888 # prepend comma to HsP flags (so hsc can tell them apart...)
1889 foreach $a ( @HsP_flags ) { $a = ",$a" unless $a =~ /^,/; }
1891 &makeHiMap() unless $HiMapDone;
1892 #print STDERR "HiIncludes: $HiIncludeString\n";
1893 push(@HsC_flags, "-himap=$HiIncludeString");
1895 # here, we may produce .hc/.s and/or .hi files
1896 local($output) = '';
1897 #@Files_to_tidy = ();
1899 if ( $going_interactive ) {
1900 # don't need .hi unless going to show it on stdout:
1901 $ProduceHi = '-nohifile=' if ! $HiOnStdout;
1902 $do_cc = 0; $do_as = 0; $Do_lnkr = 0; # and we won't go any further...
1905 # set up for producing output/.hi; note that flag twiddling
1906 # may mean that nothing will actually be produced:
1907 $output = "$ProduceHi$hsc_hi $HscOut$hsc_out";
1908 push(@Files_to_tidy, $hsc_hi, $hsc_out );
1910 # if we're compiling foo.hs, we want the GC stats to end up in foo.stat
1911 if ( $CollectingGCstats ) {
1912 push(@HsC_rts_flags, "-S$ifile_root.stat");
1913 push(@Files_to_tidy, "$ifile_root.stat");
1916 if ( $CollectGhcTimings ) { # assume $RTS_style eq 'ghc'
1917 # emit nofibbish time/bytes-alloc stats to stderr;
1918 # see later .stat file post-processing
1919 print STDERR "warning: both -Rgc-stats and -Rghc-timing used, -Rghc-timing wins." if $CollectingGCstats;
1920 push(@HsC_rts_flags, "-s$Tmp_prefix.stat");
1921 push(@Files_to_tidy, "$Tmp_prefix.stat");
1925 if ($Specific_dump_file ne '') {
1926 $dump = "2>> $Specific_dump_file";
1927 $Using_dump_file = 1;
1931 $to_do = "$HsC @HsP_flags ,$hscpp_hsc $dump @HsC_flags $CoreLint $StgLint $Verbose $output +RTS @HsC_rts_flags";
1932 &run_something($to_do, 'Haskell compiler');
1934 # finish business w/ nofibbish time/bytes-alloc stats
1935 &process_ghc_timings() if $CollectGhcTimings;
1939 Use \tr{@Import_dir} and \tr{@SysImport_dir} to make a tmp file
1940 of (module-name, pathname) pairs, one per line, separated by a space.
1943 $HiIncludeString = (); # dir1:dir2:dir3, to pass to GHC
1947 # collect in %HiMap; write later; also used elsewhere in driver
1949 local($mod, $path, $d, $e);
1951 # reset the global variables:
1953 $HiIncludeString = (); # dir1:dir2:dir3, to pass to GHC
1955 foreach $d ( @Import_dir ) {
1956 if ($HiIncludeString) {
1957 $HiIncludeString = "$HiIncludeString:${d}%.${HiSuffix}";
1959 $HiIncludeString = "$d%.${HiSuffix}";
1964 foreach $d ( @SysImport_dir ) {
1965 if ($HiIncludeString) {
1966 $HiIncludeString = "$HiIncludeString:${d}%.${HiSuffix_prelude}";
1968 $HiIncludeString = "${d}%.${HiSuffix_prelude}";
1977 %************************************************************************
1979 \section[Driver-misc-utils]{Miscellaneous utilities}
1981 %************************************************************************
1983 %************************************************************************
1985 \subsection[Driver-odir-ify]{@odir_ify@: Mangle filename if \tr{-odir} set}
1987 %************************************************************************
1991 local($ofile,$def_suffix) = @_;
1993 return(($Osuffix eq '') ? "$ofile.$def_suffix" : "$ofile.$Osuffix" );
1997 local($orig_file, $def_suffix) = @_;
1998 if ($Specific_output_dir eq '') { # do nothing
1999 &osuf_ify($orig_file, $def_suffix);
2001 local ($orig_file_only);
2002 ($orig_file_only = $orig_file) =~ s|.*/||;
2003 &osuf_ify("$Specific_output_dir/$orig_file_only",$def_suffix);
2010 local($is_hc_file, $hsc_out, $cc_as_o) = @_;
2012 local($includes) = '-I' . join(' -I', @Include_dir);
2015 local($c_flags) = "@CcBoth_flags";
2016 local($ddebug_flag) = ( $DEBUGging ) ? '-DDEBUG' : '';
2018 # "input" files to use that are not in some weird directory;
2019 # to help C compilers grok .hc files [ToDo: de-hackify]
2020 local($cc_help) = "ghc$$.c";
2021 local($cc_help_s) = "ghc$$.s";
2024 $s_output = ($is_hc_file || $TargetPlatform =~ /^(powerpc|rs6000|hppa|i386)/) ? $cc_as_o : $cc_as;
2025 $c_flags .= " @CcRegd_flags";
2026 $c_flags .= ($is_hc_file) ? " @CcRegd_flags_hc" : " @CcRegd_flags_c";
2028 # C compiler won't like the .hc extension. So we create
2029 # a tmp .c file which #include's the needful.
2030 open(TMP, "> $cc_help") || &tidy_up_and_die(1,"$Pgm: failed to open `$cc_help' (to write)\n");
2031 if ( $is_hc_file ) {
2033 #ifdef __STG_GCC_REGS__
2034 # if ! (defined(MAIN_REG_MAP) || defined(MARK_REG_MAP) || defined(SCAN_REG_MAP) || defined(SCAV_REG_MAP) || defined(FLUSH_REG_MAP))
2035 # define MAIN_REG_MAP
2038 #include "stgdefs.h"
2040 # user may have asked for #includes to be injected...
2041 print TMP @CcInjects if $#CcInjects >= 0;
2043 # heave in the consistency info
2044 print TMP "static char ghc_cc_ID[] = \"\@(#)cc $ifile\t$Cc_major_version.$Cc_minor_version,$Cc_consist_options\";\n";
2046 # and #include the real source
2047 print TMP "#include \"$hsc_out\"\n";
2048 close(TMP) || &tidy_up_and_die(1,"Failed writing to $cc_help\n");
2050 # Don't redirect stderr into intermediate file if slamming output onto stdout (e.g., with -E)
2051 local($fuse_stderr) = "2>&1" if ! $Only_preprocess_hc;
2052 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 )";
2053 # note: __GLASGOW_HASKELL__ is pointedly *not* #defined at the C level.
2055 if ( $Only_preprocess_hc ) { # HACK ALERT!
2056 $to_do =~ s/ -S\b//g;
2058 push(@Files_to_tidy, $cc_help, $cc_help_s, $s_output );
2059 $PostprocessCcOutput = 1 if ! $Only_preprocess_hc; # hack, dear hack...
2060 &run_something($to_do, 'C compiler');
2061 $PostprocessCcOutput = 0;
2062 if ( $Only_preprocess_hc ) {
2063 system("$Cat $Tmp_prefix.ccout");
2065 unlink($cc_help, $cc_help_s);
2071 local($is_hc_file, $cc_as_o, $cc_as, $ifile_root) = @_;
2073 if ( $is_hc_file ) {
2074 # dynamically load assembler-fiddling code, which we are about to use:
2075 require('ghc-asm.prl')
2076 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm.prl!\n");
2079 print STDERR `cat $cc_as_o` if $Dump_raw_asm; # to stderr, before mangling
2082 # post-process the assembler [.hc files only]
2083 &mangle_asm($cc_as_o, $cc_as);
2087 #OLD: local($target) = 'oops';
2088 #OLD: $target = '-alpha' if $TargetPlatform =~ /^alpha-/;
2089 #OLD: $target = '-hppa' if $TargetPlatform =~ /^hppa/;
2090 #OLD: $target = '-old-asm' if $TargetPlatform =~ /^i386-/;
2091 #OLD: $target = '-m68k' if $TargetPlatform =~ /^m68k-/;
2092 #OLD: $target = '-mips' if $TargetPlatform =~ /^mips-/;
2093 #OLD: $target = '' if $TargetPlatform =~ /^powerpc-/;
2094 #OLD: $target = '-solaris' if $TargetPlatform =~ /^sparc-sun-solaris2/;
2095 #OLD: $target = '-sparc' if $TargetPlatform =~ /^sparc-sun-sunos4/;
2097 #OLD: if ( $target ne '' ) {
2098 #OLD: require("ghc-asm$target.prl")
2099 #OLD: || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm$target.prl!\n");
2100 #OLD: &mangle_asm($cc_as_o, "$cc_as-2"); # the OLD one!
2101 #OLD: &run_something("$Cmp -s $cc_as-2 $cc_as || $Diff $cc_as-2 $cc_as 1>&2 || exit 0",
2102 #OLD: "Diff'ing old and new mangled .s files"); # NB: to stderr
2105 } elsif ($TargetPlatform =~ /^hppa/) {
2106 # minor mangling of non-threaded files for hp-pa only
2107 require('ghc-asm.prl')
2108 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-hppa.prl!\n");
2109 &mini_mangle_asm_hppa($cc_as_o, $cc_as);
2111 } elsif ($TargetPlatform =~ /^powerpc|^rs6000/) {
2112 # minor mangling of non-threaded files for powerpcs and rs6000s
2113 require('ghc-asm.prl')
2114 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-powerpc.prl!\n");
2115 &mini_mangle_asm_powerpc($cc_as_o, $cc_as);
2116 } elsif ($TargetPlatform =~ /^i386/) {
2117 # extremely-minor OFFENSIVE mangling of non-threaded just one file
2118 require('ghc-asm.prl')
2119 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm.prl!\n");
2120 &mini_mangle_asm_i386($cc_as_o, $cc_as);
2123 # save a copy of the .s file, even if we are carrying on...
2124 #if ($do_as && $Keep_s_file_too) {
2125 # &saveIntermediate($ifile_root , "s" , $cc_as);
2132 local($as_out, $ifile_root) = @_;
2134 local($asmblr) = ( $As ) ? $As : $CcRegd;
2136 if ( ! $SplitObjFiles ) {
2137 local($to_do) = "$asmblr -o $as_out -c @As_flags $cc_as";
2138 push(@Files_to_tidy, $as_out );
2139 &run_something($to_do, 'Unix assembler');
2141 } else { # more complicated split-ification...
2143 # must assemble files $Tmp_prefix__[1 .. $NoOfSplitFiles].s
2145 # If -odir is used, great, just pin it in front of the
2146 # generated split file names. If it hasn't been set, we
2147 # snatch it from the ifile_root.
2151 if ( $Specific_output_dir eq '' ) {
2152 $Specific_output_dir = ${ifile_root};
2155 for ($f = 1; $f <= $NoOfSplitFiles; $f++ ) {
2156 local($split_out) = &odir_ify("${ifile_root}__${f}",'o');
2157 local($to_do) = "$asmblr -o $split_out -c @As_flags ${Tmp_prefix}__${f}.s";
2158 push(@Files_to_tidy, $split_out );
2160 &run_something($to_do, 'Unix assembler');
2166 %************************************************************************
2168 \subsection[Driver-run-something]{@run_something@: Run a phase}
2170 %************************************************************************
2174 local($str_to_do, $tidy_name) = @_;
2176 print STDERR "\n$tidy_name:\n\t" if $Verbose;
2177 print STDERR "$str_to_do\n" if $Verbose;
2179 if ($Using_dump_file) {
2180 open(DUMP, ">> $Specific_dump_file")
2181 || &tidy_up_and_die(1,"$Pgm: failed to open `$Specific_dump_file'\n");
2182 print DUMP "\nCompilation Dump for: $str_to_do\n\n";
2184 || &tidy_up_and_die(1,"$Pgm: failed closing `$Specific_dump_file'\n");
2187 local($return_val) = 0;
2189 if ( length($str_to_do) > 4000) {
2190 # 4000 - on the random side, just like the *real* ARG_MAX
2193 # With some shells, command lines of this length may
2194 # very well cause trouble. To safeguard against this, we squirrel the
2195 # command into a file and exec that.
2196 local ($sh) = $ENV{'REAL_SHELL'};
2197 print STDERR "Backup plan A: saving cmd line in ${Tmp_prefix}.sh and executing that with $sh\n" if $Verbose;
2198 open (TEMP, "> ${Tmp_prefix}.sh") ||
2199 &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.sh'\n");
2200 print TEMP "$Time $str_to_do\n";
2202 &tidy_up_and_die(1,"$Pgm: failed closing `$Tmp_prefix.sh'\n");
2203 system("$sh $Tmp_prefix.sh");
2206 unlink "${Tmp_prefix}.sh";
2208 system("$Time $str_to_do");
2212 if ( $PostprocessCcOutput ) { # hack, continued
2213 open(CCOUT, "< $Tmp_prefix.ccout")
2214 || &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.ccout'\n");
2216 next if /attribute directive ignored/;
2217 next if /call-clobbered/;
2218 next if /from .*COptRegs\.lh/;
2219 next if /from .*(stg|rts)defs\.h:/;
2220 next if /from ghc\d+.c:\d+:/;
2221 next if /from .*\.lc/;
2222 next if /from .*SMinternal\.l?h/;
2223 next if /ANSI C does not support \`long long\'/;
2224 next if /warning:.*was declared \`extern\' and later \`static\'/;
2225 next if /warning: assignment discards \`const\' from pointer target type/;
2226 next if /: At top level:$/;
2227 next if /: In function \`.*\':$/;
2228 next if /\`ghc_cc_ID\' defined but not used/;
2231 close(CCOUT) || &tidy_up_and_die(1,"$Pgm: failed closing `$Tmp_prefix.ccout'\n");
2234 if ($return_val != 0) {
2235 if ($Using_dump_file) {
2236 print STDERR "Compilation Errors dumped in $Specific_dump_file\n";
2239 &tidy_up_and_die($return_val, '');
2241 $Using_dump_file = 0;
2245 %************************************************************************
2247 \subsection[Driver-ghc-timing]{Emit nofibbish GHC timings}
2249 %************************************************************************
2251 NB: nearly the same as in @runstdtest@ script.
2254 sub process_ghc_timings {
2255 local($StatsFile) = "$Tmp_prefix.stat";
2256 local($SysSpecificTiming) = 'ghc';
2258 open(STATS, $StatsFile) || die "Failed when opening $StatsFile\n";
2259 local($max_live) = 0;
2260 local($tot_live) = 0; # for calculating residency stuff
2261 local($tot_samples) = 0;
2264 if (! /Minor/ && /^\s*\d+\s+\d+\s+(\d+)\s+\d+\.\d+\%/ ) {
2265 $max_live = $1 if $max_live < $1;
2269 $BytesAlloc = $1 if /^\s*([0-9,]+) bytes allocated in the heap/;
2271 if ( /^\s*([0-9,]+) bytes maximum residency .* (\d+) sample/ ) {
2272 $MaxResidency = $1; $ResidencySamples = $2;
2275 $GCs = $1 if /^\s*([0-9,]+) garbage collections? performed/;
2277 # The presence of -? in the following pattern is only there to
2278 # accommodate 0.29 && <= 2.05 RTS'
2279 if ( /^\s*INIT\s+time\s*(\d+\.\d\d)s\s*\(\s*-?(\d+\.\d\d)s elapsed\)/ ) {
2280 $InitTime = $1; $InitElapsed = $2;
2281 } elsif ( /^\s*MUT\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2282 $MutTime = $1; $MutElapsed = $2;
2283 } elsif ( /^\s*GC\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2284 $GcTime = $1; $GcElapsed = $2;
2287 close(STATS) || die "Failed when closing $StatsFile\n";
2288 if ( $tot_samples > 0 ) {
2289 $ResidencySamples = $tot_samples;
2290 $MaxResidency = $max_live;
2291 $AvgResidency = int ($tot_live / $tot_samples) ;
2294 # warn about what we didn't find
2295 print STDERR "Warning: BytesAlloc not found in stats file\n" unless defined($BytesAlloc);
2296 print STDERR "Warning: GCs not found in stats file\n" unless defined($GCs);
2297 print STDERR "Warning: InitTime not found in stats file\n" unless defined($InitTime);
2298 print STDERR "Warning: InitElapsed not found in stats file\n" unless defined($InitElapsed);
2299 print STDERR "Warning: MutTime not found in stats file\n" unless defined($MutTime);
2300 print STDERR "Warning: MutElapsed not found in stats file\n" unless defined($MutElapsed);
2301 print STDERR "Warning: GcTime inot found in stats file\n" unless defined($GcTime);
2302 print STDERR "Warning: GcElapsed not found in stats file\n" unless defined($GcElapsed);
2304 # things we didn't necessarily expect to find
2305 $MaxResidency = 0 unless defined($MaxResidency);
2306 $AvgResidency = 0 unless defined($AvgResidency);
2307 $ResidencySamples = 0 unless defined($ResidencySamples);
2310 $BytesAlloc =~ s/,//g;
2311 $MaxResidency =~ s/,//g;
2313 $InitTime =~ s/,//g;
2314 $InitElapsed =~ s/,//g;
2316 $MutElapsed =~ s/,//g;
2318 $GcElapsed =~ s/,//g;
2320 # print out what we found
2321 print STDERR "<<$SysSpecificTiming: ",
2322 "$BytesAlloc bytes, $GCs GCs, $AvgResidency/$MaxResidency avg/max bytes residency ($ResidencySamples samples), $InitTime INIT ($InitElapsed elapsed), $MutTime MUT ($MutElapsed elapsed), $GcTime GC ($GcElapsed elapsed)",
2323 " :$SysSpecificTiming>>\n";
2330 %************************************************************************
2332 \subsection[Driver-dying]{@tidy_up@ and @tidy_up_and_die@: Dying gracefully}
2334 %************************************************************************
2338 local($to_do) = "\n$Rm $Tmp_prefix*";
2339 if ( $Tmp_prefix !~ /^\s*$/ ) {
2340 print STDERR "$to_do\n" if $Verbose;
2345 sub tidy_up_and_die {
2346 local($return_val, $msg) = @_;
2348 # delete any files to tidy
2349 print STDERR "deleting... @Files_to_tidy\n" if $Verbose && $#Files_to_tidy >= 0;
2350 unlink @Files_to_tidy if $#Files_to_tidy >= 0;
2354 exit (($return_val == 0) ? 0 : 1);
2358 %************************************************************************
2360 \subsection[Driver-arg-with-arg]{@grab_arg_arg@: Do an argument with an argument}
2362 %************************************************************************
2364 Some command-line arguments take an argument, e.g.,
2365 \tr{-Rmax-heapsize} expects a number to follow. This can either be
2366 given a part of the same argument (\tr{-Rmax-heapsize8M}) or as the
2367 next argument (\tr{-Rmax-heapsize 8M}). We allow both cases.
2369 Note: no error-checking; \tr{-Rmax-heapsize -Rgc-stats} will silently
2370 gobble the second argument (and probably set the heapsize to something
2374 local(*Args, $option, $rest_of_arg) = @_;
2376 if ($rest_of_arg ne '') {
2377 return($rest_of_arg);
2378 } elsif ($#Args >= 0) {
2379 local($temp) = $Args[0]; shift(@Args);
2382 print STDERR "$Pgm: no argument following $option option\n";
2393 #Not in HsC_antiflag ## NO!: and not already in HsC_flags
2395 foreach $f ( @HsC_antiflags ) {
2396 return(0) if $flag eq $f;
2398 # foreach $f ( @HsC_flags ) {
2399 # return(0) if $flag eq $f;
2404 sub squashHscFlag { # pretty terrible
2408 foreach $f ( @HsC_flags ) {
2409 if ($flag eq $f) { $f = ''; }
2417 foreach $f ( @flags ) {
2418 push( @HsC_flags, $f ) if &isntAntiFlag($f);
2423 Source files may have {-# OPTIONS ... #-} pragmas at the top, containing
2424 command line options we want to append to collection of commands specified
2425 directly. @check_for_source_options@ looks at the top of a de-lit'ified Haskell
2426 file for any such pragmas:
2429 sub check_for_source_options {
2430 local($file,$ifile) = @_;
2431 local($comment_start,$comment_end);
2433 if ($ifile =~ /\.hc$/ ||
2436 $ifile =~ /_s$/ ) { # `Real' C intermediate
2437 $comment_start = "/\\*";
2438 $comment_end = "\\*/";
2439 } else { # Assume it is a file containing Haskell source
2440 $comment_start = "{-#";
2441 $comment_end = "#-}";
2444 open(FILE,$file) || return(1); # No big loss
2447 if ( /^${comment_start} OPTIONS (.*)${comment_end}$/ ) {
2448 # add the options found at the back of the command line.
2449 local(@entries) = split(/\s+/,$1);
2450 print STDERR "Found OPTIONS " . join(' ',@entries) . " in $file\n" if $Verbose;
2451 push(@File_options, @entries);
2453 elsif ( /^$/ ) { # ignore empty lines
2456 elsif ( /^#line.+$/ ) { # ignore comment lines (unused..ToDo: rm )
2459 elsif ( /^{-# LINE.+$/ ) { # ignore line pragmas
2462 else { # stop looking, something non-empty / not
2463 # ${comment_start} OPTIONS .. ${comment_end} encountered.
2464 close(FILE);return(0);
2473 We split the initial argv up into three arrays:
2479 the reason for doing so is to be able to deal
2480 with {-# OPTIONS #-} pragma in source files properly.
2486 arg: while($_ = $args[0]) {
2488 # sigh, we have to deal with these -option arg specially here.
2489 /^-(tmpdir|odir|ohi|o|isuf|osuf|hisuf|hisuf-prelude|odump|syslib)$/ &&
2490 do { push(@Cmd_opts, $_); push(@Cmd_opts,$args[0]); shift(@args); next arg; };
2491 /^--?./ && do { push(@Cmd_opts, $_); next arg; };
2493 if (/\.([^_]+_)?[oa]$/) {
2494 push(@Link_file, $_);
2496 push(@Input_file, $_);
2499 # input files must exist:
2501 print STDERR "$Pgm: input file doesn't exist: $_\n";
2509 When saving an intermediate file (.hc or .s) away, we
2510 have to prefix any OPTIONS found in the original source file.
2513 sub saveIntermediate {
2514 local ($final,$suffix,$tmp)= @_ ;
2517 # $final -- root of where to park ${final}.${suffix}
2518 # $tmp -- temporary file where hsc put the intermediate file.
2520 # Delete the old file
2521 $to_do = "$Rm ${final}.${suffix}"; &run_something($to_do, "Removing old .${suffix} file");
2523 if ( $#File_options >= 0 ) { # OPTIONS found in Haskell source unit
2524 # Add OPTION comment to the top of the generated .${suffix} file
2525 open(TEMP, "> ${final}.${suffix}") || &tidy_up_and_die(1,"Can't open ${final}.${suffix}\n");
2526 print TEMP "/* OPTIONS " . join(' ',@File_options) . " */\n";
2528 print STDERR "Prepending OPTIONS: " . join(' ',@File_options) . " to ${final}.${suffix}\n" if $Verbose;
2530 $to_do = "$Cat $tmp >> ${final}.${suffix}";
2531 &run_something($to_do, "Saving copy of .${suffix} file");
2538 Command-line processor
2544 # can't use getopt(s); what we want is too complicated
2546 arg: while($_ = $Args[0]) {
2549 #---------- help -------------------------------------------------------
2550 if (/^-\?$/ || /^--?help$/) { print $LongUsage; exit $Status; }
2552 #-----------version ----------------------------------------------------
2553 /^--version$/ && do { print STDERR "${PROJECTNAME}, version ${PROJECTVERSION}, patchlevel ${PROJECTPATCHLEVEL}\n"; exit $Status; };
2555 #---------- verbosity and such -----------------------------------------
2556 /^-v$/ && do { $Verbose = '-v'; $Time = 'time'; next arg; };
2558 #---------- what phases are to be run ----------------------------------
2559 /^-(no-)?recomp/ && do { $Do_recomp_chkr = ($1 eq '') ? 1 : 0; next arg; };
2561 /^-cpp$/ && do { $Cpp_flag_set = 1; next arg; };
2562 # change the global default:
2563 # we won't run cat; we'll run the real thing
2565 /^-C$/ && do { $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0; $HscOut = '-C=';
2567 # stop after generating C
2569 /^-noC$/ && do { $HscOut = '-N='; $ProduceHi = '-nohifile=';
2570 $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0;
2572 # leave out actual C generation (debugging) [also turns off interface gen]
2574 /^-hi$/ && do { $HiOnStdout = 1; $ProduceHi = '-hifile='; next arg; };
2575 # _do_ generate an interface; usually used as: -noC -hi
2577 /^-nohi$/ && do { $ProduceHi = '-nohifile='; next arg; };
2578 # don't generate an interface (even if generating C)
2580 /^-hi-diffs$/ && do { $HiDiff_flag = 'normal'; next arg; };
2581 /^-hi-diffs-with-usages$/ && do { $HiDiff_flag = 'usages'; next arg; };
2582 /^-no-hi-diffs$/ && do { $HiDiff_flag = ''; next arg; };
2583 /^-keep-hi-diffs$/ && do { $Keep_HiDiffs = 1; next arg; };
2585 # show/disable diffs if the interface file changes
2587 /^-E$/ && do { push(@CcBoth_flags, '-E');
2588 $Only_preprocess_C = 1;
2589 $Do_as = 0; $Do_lnkr = 0; next arg; };
2590 # stop after preprocessing C
2591 /^-M$/ && do { $Only_generate_deps = 1; $Do_as = 0; $Do_lnkr = 0; next arg; };
2592 # only generate dependency information.
2593 /^-S$/ && do { $Do_as = 0; $Do_lnkr = 0; next arg; };
2594 # stop after generating assembler
2596 /^-c$/ && do { $Do_lnkr = 0; next arg; };
2597 # stop after generating .o files
2599 /^-link-chk$/ && do { $LinkChk = 1; next arg; };
2600 /^-no-link-chk$/ && do { $LinkChk = 0; next arg; };
2601 # don't do consistency-checking after a link
2603 /^-tmpdir$/ && do { $Tmp_prefix = &grab_arg_arg(*Args,'-tmpdir', '');
2604 $Tmp_prefix = "$Tmp_prefix/ghc$$";
2605 $ENV{'TMPDIR'} = $Tmp_prefix; # for those who use it...
2607 # use an alternate directory for temp files
2609 #---------- redirect output --------------------------------------------
2611 # -o <file>; applies to the last phase, whatever it is
2612 # "-o -" sends it to stdout
2613 # if <file> has a directory component, that dir must already exist
2615 /^-odir$/ && do { $Specific_output_dir = &grab_arg_arg(*Args,'-odir', '');
2617 # Hack, of the worst sort: don't do validation of
2618 # odir argument if you're using -M (dependency generation).
2620 if ( ! $Only_generate_deps && ! -d $Specific_output_dir) {
2621 print STDERR "$Pgm: -odir: no such directory: $Specific_output_dir\n";
2626 /^-o$/ && do { $Specific_output_file = &grab_arg_arg(*Args,'-o', '');
2627 if ($Specific_output_file ne '-'
2628 && $Specific_output_file =~ /(.*)\/[^\/]*$/) {
2629 local($dir_part) = $1;
2630 if (! -d $dir_part) {
2631 print STDERR "$Pgm: no such directory: $dir_part\n";
2637 # NB: -isuf not documented yet (because it doesn't work yet)
2638 /^-isuf$/ && do { $Isuffix = &grab_arg_arg(*Args,'-isuf', '');
2639 if ($Isuffix =~ /\./ ) {
2640 print STDERR "$Pgm: -isuf suffix shouldn't contain a .\n";
2645 /^-osuf$/ && do { $Osuffix = &grab_arg_arg(*Args,'-osuf', '');
2646 if ($Osuffix =~ /\./ ) {
2647 print STDERR "$Pgm: -osuf suffix shouldn't contain a .\n";
2652 # -ohi <file>; send the interface to <file>; "-ohi -" to send to stdout
2653 /^-ohi$/ && do { $Specific_hi_file = &grab_arg_arg(*Args,'-ohi', '');
2654 if ($Specific_hi_file ne '-'
2655 && $Specific_hi_file =~ /(.*)\/[^\/]*$/) {
2656 local($dir_part) = $1;
2657 if (! -d $dir_part) {
2658 print STDERR "$Pgm: no such directory: $dir_part\n";
2664 # The suffix to use when looking for interface files
2665 /^-hisuf$/ && do { $HiSuffix = &grab_arg_arg(*Args,'-hisuf', '');
2666 if ($HiSuffix =~ /\./ ) {
2667 print STDERR "$Pgm: -hisuf suffix shouldn't contain a .\n";
2671 # ToDo: remove, not a `normal' user thing to do (should be automatic)
2672 /^-hisuf-prelude$/ && do { $HiSuffix_prelude = &grab_arg_arg(*Args,'-hisuf-prelude', '');
2673 if ($HiSuffix =~ /\./ ) {
2674 print STDERR "$Pgm: -hisuf-prelude suffix shouldn't contain a .\n";
2678 /^-odump$/ && do { $Specific_dump_file = &grab_arg_arg(*Args,'-odump', '');
2679 if ($Specific_dump_file =~ /(.*)\/[^\/]*$/) {
2680 local($dir_part) = $1;
2681 if (! -d $dir_part) {
2682 print STDERR "$Pgm: no such directory: $dir_part\n";
2688 #-------------- scc & Profiling Stuff ----------------------------------
2690 /^-prof$/ && do { $PROFing = 'p'; next arg; }; # profiling -- details later!
2693 # generate auto SCCs on top level bindings
2694 # -auto-all = all top level bindings
2695 # -auto = only top level exported bindings
2696 $PROFauto = ( /-all/ )
2697 ? '-fauto-sccs-on-all-toplevs'
2698 : '-fauto-sccs-on-exported-toplevs';
2701 /^-caf-all/ && do { # generate individual CAF SCC annotations
2702 $PROFcaf = '-fauto-sccs-on-individual-cafs';
2705 /^-ignore-scc$/ && do {
2706 # forces ignore of scc annotations even if profiling
2707 $PROFignore_scc = '-W';
2710 /^-G(.*)$/ && do { push(@HsC_flags, "-G=$1"); # set group for cost centres
2713 /^-unprof-scc-auto/ && do {
2714 # generate auto SCCs on top level bindings when not profiling.
2715 # Used to measure optimisation effects of presence of sccs.
2716 $UNPROFscc_auto = ( /-all/ )
2717 ? '-fauto-sccs-on-all-toplevs'
2718 : '-fauto-sccs-on-exported-toplevs';
2721 #--------- ticky/concurrent/parallel -----------------------------------
2722 # we sort out the details a bit later on
2724 /^-concurrent$/ && do { $CONCURing = 'c'; next arg; }; # concurrent Haskell
2725 /^-gransim$/ && do { $GRANing = 'g'; next arg; }; # GranSim
2726 /^-ticky$/ && do { $TICKYing = 't'; next arg; }; # ticky-ticky
2727 /^-parallel$/ && do { $PARing = 'p'; next arg; }; # parallel Haskell
2729 #-------------- "user ways" --------------------------------------------
2731 (/^-user-setup-([a-oA-Z])$/ ) &&
2733 /^-user-setup-([a-oA-Z])$/ && do { $BuildTag = "_$1"; };
2735 local($stuff) = $UserSetupOpts{$BuildTag};
2736 local(@opts) = split(/\s+/, $stuff);
2738 # feed relevant ops into the arg-processing loop (if any)
2739 unshift(@Args, @opts) if $#opts >= 0;
2743 #---------- set search paths for libraries and things ------------------
2745 # we do -i just like HBC (-i clears the list; -i<colon-separated-items>
2746 # prepends the items to the list); -I is for including C .h files.
2748 /^-i$/ && do { @Import_dir = (); # import path cleared!
2749 @SysImport_dir = ();
2750 print STDERR "WARNING: import paths cleared by `-i'\n";
2753 /^-i(.*)/ && do { local(@new_items)
2754 = split( /:/, &grab_arg_arg(*Args,'-i', $1));
2755 unshift(@Import_dir, @new_items);
2758 /^-I(.*)/ && do { push(@Include_dir, &grab_arg_arg(*Args,'-I', $1)); next arg; };
2759 /^-L(.*)/ && do { push(@UserLibrary_dir, &grab_arg_arg(*Args,'-L', $1)); next arg; };
2760 /^-l(.*)/ && do { push(@UserLibrary,'-l'.&grab_arg_arg(*Args,'-l', $1)); next arg; };
2762 /^-syslib(.*)/ && do { local($syslib) = &grab_arg_arg(*Args,'-syslib',$1);
2763 print STDERR "$Pgm: no such system library (-syslib): $syslib\n",
2764 $Status++ unless $syslib =~ /^(hbc|ghc|posix|contrib)$/;
2768 # The posix library is a `special' in that it relies on
2769 # the ghc system library (packed strings). Wielding our
2770 # sledgehammer, the problem is solved by silently including
2771 # the ghc system library as well.
2772 # (ToDo: `nub' -syslib list)
2774 unshift(@SysImport_dir,
2776 ? "$InstSysLibDir/$syslib/imports"
2777 : "$TopPwd/hslibs/$syslib/src");
2779 push(@SysLibrary_dir,
2781 ? ("$InstSysLibDir")
2782 : ("$TopPwd/hslibs/$syslib"
2783 ,"$TopPwd/hslibs/$syslib/cbits"));
2785 push(@SysLibrary, "-lHS$syslib");
2786 push(@SysLibrary, "-lHS${syslib}_cbits")
2787 unless $syslib eq 'contrib'; #HACK! it has no cbits
2789 if ( $syslib eq 'posix') {
2795 #=======================================================================
2796 # various flags that we can harmlessly send to one program or another
2797 # (we will later "reclaim" some of the compiler ones now sent to gcc)
2798 #=======================================================================
2800 #---------- this driver itself (ghc) -----------------------------------
2801 # these change what executable is run for each phase:
2802 /^-pgmL(.*)$/ && do { $Unlit = $1; next arg; };
2803 /^-pgmP(.*)$/ && do { $HsCpp = $1; next arg; };
2804 /^-pgmC(.*)$/ && do { $HsC = $1; next arg; };
2805 /^-pgmcO?(.*)$/ && do { $CcRegd = $1; next arg; }; # the O? for back compat
2806 /^-pgma(.*)$/ && do { $As = $1; next arg; };
2807 /^-pgml(.*)$/ && do { $Lnkr = $1; next arg; };
2808 /^-pgmdep(.*)$/ && do { $MkDependHS = $1; next arg; };
2810 #---------- the get-anything-through opts (all pgms) -------------------
2811 # these allow arbitrary option-strings to go to any phase:
2812 /^-optL(.*)$/ && do { push(@Unlit_flags, $1); next arg; };
2813 /^-optP(.*)$/ && do { push(@HsCpp_flags, $1); next arg; };
2814 /^-optCrts(.*)$/&& do { push(@HsC_rts_flags, $1); next arg; };
2815 /^-optC(.*)$/ && do { push(@HsC_flags, $1); next arg; };
2816 /^-optcpp(.*)$/ && do { push(@Cpp_define, $1); $Only_preprocess_hc = ($1 eq "-E"); next arg; };
2817 /^-optc(.*)$/ && do { push(@CcBoth_flags, $1); next arg; };
2818 /^-opta(.*)$/ && do { push(@As_flags, $1); next arg; };
2819 /^-optl(.*)$/ && do { push(@Ld_flags, $1); next arg; };
2820 /^-optdep(.*)$/ && do { push(@MkDependHS_flags, $1); next arg; };
2822 #---------- Haskell C pre-processor (hscpp) ----------------------------
2823 /^-D(.*)/ && do { push(@HsCpp_flags, "'-D".&grab_arg_arg(*Args,'-D',$1)."'"); next arg; };
2824 /^-U(.*)/ && do { push(@HsCpp_flags, "'-U".&grab_arg_arg(*Args,'-U',$1)."'"); next arg; };
2826 /^-genSPECS/ && do { $Cpp_flag_set = 1;
2827 $genSPECS_flag = $_;
2830 #---------- post-Haskell "assembler"------------------------------------
2831 /^-ddump-raw-asm$/ && do { $Dump_raw_asm = 1; next arg; };
2832 /^-ddump-asm-splitting-info$/ && do { $Dump_asm_splitting_info = 1; next arg; };
2834 #---------- Haskell compiler (hsc) -------------------------------------
2836 /^-keep-hc-files?-too$/ && do { $Keep_hc_file_too = 1; next arg; };
2837 /^-keep-s-files?-too$/ && do { $Keep_s_file_too = 1; next arg; };
2839 /^-fhaskell-1\.3$/ && do { next arg; }; # a no-op right now
2841 /^-fignore-interface-pragmas$/ && do { push(@HsC_flags, $_); next arg; };
2843 /^-fno-implicit-prelude$/ && do { $NoImplicitPrelude= 1; push(@HsC_flags, $_); next arg; };
2844 # don't do stack checking using page fault `trick'.
2846 /^-fstack-check$/ && do { $StkChkByPageFaultOK = 0; next arg; };
2848 # have the compiler proper generate concurrent code,
2849 # really only used when you want to configure your own
2850 # special user compilation way. (Use -concurrent when
2851 # compiling `Concurrent Haskell' programs).
2853 # (ditto for -fgransim, fscc-profiling and -fticky-ticky)
2855 /^-fconcurrent$/ && do { push(@HsC_flags,$_); next arg; };
2856 /^-fscc-profiling$/ && do { push(@HsC_flags,$_); next arg; };
2857 /^-fticky-ticky$/ && do { push(@HsC_flags,$_); next arg; };
2858 /^-fgransim$/ && do { push(@HsC_flags,$_); next arg; };
2860 /^-split-objs/ && do {
2861 if ( $TargetPlatform !~ /^(alpha|hppa1\.1|i386|m68k|mips|powerpc|rs6000|sparc)-/ ) {
2863 print STDERR "WARNING: don't know how to split objects on this platform: $TargetPlatform\n`-split-objs' option ignored\n";
2868 push(@HsC_flags, "-fglobalise-toplev-names");
2869 push(@CcBoth_flags, '-DUSE_SPLIT_MARKERS');
2871 require('ghc-split.prl')
2872 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-split.prl!\n");
2877 && do { push(@HsC_flags, $_);
2878 push(@HsP_flags, '-N');
2880 # push(@HsC_flags, '-fshow-import-specs');
2884 /^-fspeciali[sz]e-unboxed$/
2885 && do { $Oopt_DoSpecialise = '-fspecialise';
2886 $Oopt_SpecialiseUnboxed = '-fspecialise-unboxed';
2889 && do { $Oopt_DoSpecialise = '-fspecialise'; next arg; };
2890 /^-fno-speciali[sz]e$/
2891 && do { $Oopt_DoSpecialise = ''; next arg; };
2894 # Now the foldr/build options, which are *on* by default (for -O).
2897 && do { $Oopt_FoldrBuild = 1;
2898 $Oopt_FB_Support = '-fdo-arity-expand';
2902 /^-fno-foldr-build$/
2903 && do { $Oopt_FoldrBuild = 0;
2904 $Oopt_FB_Support = '';
2907 /^-fno-foldr-build-rule$/
2908 && do { $Oopt_FoldrBuild = 0;
2911 /^-fno-enable-tech$/
2912 && do { $Oopt_FB_Support = '';
2915 /^-fno-snapback-to-append$/
2916 && do { $Oopt_FoldrBuildInline .= ' -fdo-not-fold-back-append ';
2919 # --------------- Renamer -------------
2922 /^-fno-prune-tydecls$/ && do { push(@HsC_flags, $_); next arg; };
2923 /^-fno-prune-instdecls$/ && do { push(@HsC_flags, $_); next arg; };
2927 /^-fasm-(.*)$/ && do { $HscOut = '-S='; next arg; }; # force using nativeGen
2928 /^-fvia-[cC]$/ && do { $HscOut = '-C='; next arg; }; # force using C compiler
2932 /^(-funfolding-use-threshold)(.*)$/
2933 && do { $Oopt_UnfoldingUseThreshold = $1 . &grab_arg_arg(*Args,$1, $2);
2936 /^(-fmax-simplifier-iterations)(.*)$/
2937 && do { $Oopt_MaxSimplifierIterations = $1 . &grab_arg_arg(*Args,$1, $2);
2939 /^(-fshow-simplifier-progress)/
2940 && do { $Oopt_ShowSimplifierProgress = $1;
2943 /^-fno-pedantic-bottoms$/
2944 && do { $Oopt_PedanticBottoms = ''; next arg; };
2946 /^-fdo-monad-eta-expansion$/
2947 && do { $Oopt_MonadEtaExpansion = $_; next arg; };
2949 /^-fno-let-from-(case|app|strict-let)$/ # experimental, really (WDP 95/10)
2950 && do { push(@HsC_flags, $_); next arg; };
2952 /^(-freturn-in-regs-threshold)(.*)$/
2953 && do { local($what) = $1;
2954 local($num) = &grab_arg_arg(*Args,$what, $2);
2955 if ($num < 2 || $num > 8) {
2956 die "Bad experimental flag: $_\n";
2958 $HscOut = '-C='; # force using C compiler
2959 push(@HsC_flags, "$what$num");
2960 push(@CcRegd_flags, "-D__STG_REGS_AVAIL__=$num");
2964 # --------------- Warnings etc. ------
2966 /^-fshow-import-specs/
2967 && do { push(@HsC_flags, $_); next arg; };
2969 /^-fwarn-(.*)$/ && do { push(@HsC_flags, $_); next arg; };
2971 /^-fno-(.*)$/ && do { push(@HsC_antiflags, "-f$1");
2972 &squashHscFlag("-f$1");
2975 /^-W$/ && do { push(@HsC_flags, @MinusWOpts); next arg; };
2976 /^-Wall$/ && do { push(@HsC_flags, @MinusWallOpts); next arg; };
2977 /^-Wnot$/ && do { foreach (@Hsc_flags) {
2978 /^-fwarn-(.*)$/ && do { $_=''; };
2980 push(@HsC_antiflags, @StandardWarnings);
2983 # --------------- platform specific flags (for gcc mostly) ----------------
2985 /^-mlong-calls$/ && do { # for GCC for HP-PA boxes,
2986 # for 2.6.x..?, does not apply for 2.7.2
2988 unshift(@CcBoth_flags, ( $_ ));
2991 /^-m(v8|sparclite|cypress|supersparc|cpu=(cypress|supersparc))$/
2992 && do { # for GCC for SPARCs
2993 unshift(@CcBoth_flags, ( $_ ));
2996 /^-monly-([432])-regs/ && do { # for iX86 boxes only; no effect otherwise
2997 $StolenX86Regs = $1;
3000 #*************** ... and lots of debugging ones (form: -d* )
3002 # -d(no-)core-lint is done this way so it is turn-off-able.
3003 /^-dcore-lint/ && do { $CoreLint = '-dcore-lint'; next arg; };
3004 /^-dno-core-lint/ && do { $CoreLint = ''; next arg; };
3005 # Ditto for STG lint
3006 /^-dstg-lint/ && do { $StgLint = '-dstg-lint'; next arg; };
3007 /^-dno-stg-lint/ && do { $StgLint = ''; next arg; };
3009 /^-d(dump|ppr)-/ && do { push(@HsC_flags, $_); next arg; };
3010 /^-dverbose-(simpl|stg)/ && do { push(@HsC_flags, $_); next arg; };
3011 /^-dshow-passes/ && do { push(@HsC_flags, $_); next arg; };
3012 /^-dshow-rn-stats/ && do { push(@HsC_flags, $_); next arg; };
3013 /^-dshow-rn-trace/ && do { push(@HsC_flags, $_); next arg; };
3014 /^-dsource-stats/ && do { push(@HsC_flags, $_); next arg; };
3015 /^-dsimplifier-stats/ && do { push(@HsC_flags, $_); next arg; };
3016 /^-dstg-stats/ && do { $Oopt_StgStats = $_; next arg; };
3018 #*************** ... and now all these -R* ones for its runtime system...
3020 /^-Rscale-sizes?(.*)/ && do {
3021 $Scale_sizes_by = &grab_arg_arg(*Args,'-Rscale-sizes', $1);
3024 /^(-H|-Rmax-heapsize)(.*)/ && do {
3025 local($heap_size) = &grab_arg_arg(*Args,$1, $2);
3026 if ($heap_size =~ /(\d+)[Kk]$/) {
3027 $heap_size = $1 * 1000;
3028 } elsif ($heap_size =~ /(\d+)[Mm]$/) {
3029 $heap_size = $1 * 1000 * 1000;
3030 } elsif ($heap_size =~ /(\d+)[Gg]$/) {
3031 $heap_size = $1 * 1000 * 1000 * 1000;
3033 if ($heap_size <= 0) {
3034 print STDERR "$Pgm: resetting heap-size to zero!!! $heap_size\n";
3035 $Specific_heap_size = 0;
3037 # if several heap sizes given, take the largest...
3038 } elsif ($heap_size >= $Specific_heap_size) {
3039 $Specific_heap_size = $heap_size;
3041 print STDERR "$Pgm: ignoring heap-size-setting option ($_)...not the largest seen\n";
3045 /^(-K|Rmax-(stk|stack)size)(.*)/ && do {
3047 local($stk_size) = &grab_arg_arg(*Args,'-Rmax-stksize', $3);
3048 if ($stk_size =~ /(\d+)[Kk]$/) {
3049 $stk_size = $1 * 1000;
3050 } elsif ($stk_size =~ /(\d+)[Mm]$/) {
3051 $stk_size = $1 * 1000 * 1000;
3052 } elsif ($stk_size =~ /(\d+)[Gg]$/) {
3053 $stk_size = $1 * 1000 * 1000 * 1000;
3055 if ($stk_size <= 0) {
3056 print STDERR "$Pgm: resetting stack-size to zero!!! $stk_size\n";
3057 $Specific_stk_size = 0;
3059 # if several stack sizes given, take the largest...
3060 } elsif ($stk_size >= $Specific_stk_size) {
3061 $Specific_stk_size = $stk_size;
3063 print STDERR "$Pgm: ignoring stack-size-setting option ($flag $stk_size)...not the largest seen\n";
3067 /^-Rgc-stats$/ && do { $CollectingGCstats++;
3068 # the two RTSs do this diff ways; we will try to compensate
3071 /^-Rghc-timing/ && do { $CollectGhcTimings = 1; next arg; };
3073 #---------- C high-level assembler (gcc) -------------------------------
3074 /^-(Wall|ansi|pedantic)$/ && do { push(@CcBoth_flags, $_); next arg; };
3076 # -dgcc-lint is a useful way of making GCC very fussy.
3077 # From alan@spri.levels.unisa.edu.au (Alan Modra).
3078 /^-dgcc-lint$/ && do { push(@CcBoth_flags, '-Wall -Wpointer-arith -Wbad-function-cast -Wcast-qual -Wstrict-prototypes -Wmissing-prototypes -Wmissing-declarations -Wnested-externs'); next arg; };
3079 # An alternate set, from mark@sgcs.com (Mark W. Snitily)
3080 # -Wall -Wstrict-prototypes -Wmissing-prototypes -Wcast-align -Wshadow
3082 # inject "#include <wurble>" into the compiler's C output!
3084 /^-#include(.*)/ && do {
3085 local($to_include) = &grab_arg_arg(*Args,'-#include', $1);
3086 push(@CcInjects, "#include $to_include\n");
3089 #---------- Linker (gcc, really) ---------------------------------------
3091 /^-static$/ && do { push(@Ld_flags, $_); next arg; };
3093 #---------- mixed cc and linker magic ----------------------------------
3094 # this optimisation stuff is finally sorted out later on...
3096 /^-O2-for-C$/ && do { $MinusO2ForC = 1; next arg; };
3098 /^-O[1-2]?$/ && do {
3099 local($opt_lev) = ( /^-O2$/ ) ? 2 : 1; # max 'em
3100 $OptLevel = ( $opt_lev > $OptLevel ) ? $opt_lev : $OptLevel;
3102 $HscOut = '-C=' if $OptLevel == 2; # force use of C compiler
3105 /^-Onot$/ && do { $OptLevel = 0; next arg; }; # # set it to <no opt>
3107 /^-Ofile(.*)/ && do {
3109 local($ofile) = &grab_arg_arg(*Args,'-Ofile', $1);
3110 @HsC_minusO3_flags = ();
3112 open(OFILE, "< $ofile") || die "Can't open $ofile!\n";
3115 s/\#.*//; # death to comments
3116 s/[ \t]+//g; # death to whitespace
3117 next if /^$/; # ditto, blank lines
3118 s/([()*{}])/\\$1/g; # protect shell metacharacters
3120 push(@CcBoth_flags, $1);
3122 push(@HsC_minusO3_flags, $_);
3128 /^-debug$/ && do { # all this does is mark a .hc/.o as "debugging"
3129 # in the consistency info
3133 #---------- linking .a file --------------------------------------------
3135 /^-Main(.*)/ && do {
3136 # specifies main or mainPrimIO to be linked
3140 #---------- catch unrecognized flags -----------------------------------
3143 print STDERR "$Pgm: unrecognised option: $_\n";
3149 } # end of processArgs