1 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1997
4 This is the driver script for the Glasgow Haskell compilation system.
5 It is written in \tr{perl}. The first section includes a long
6 ``usage'' message that describes how the driver is supposed to work.
8 %************************************************************************
10 \section[Driver-usage]{Usage message}
12 %************************************************************************
15 ($Pgm = $0) =~ s|.*/||;
16 $ShortUsage = "\nUsage: For basic information, try the `-help' option.\n";
17 $LongUsage = "\n" . <<EOUSAGE;
18 Use of the Glorious Haskell Compilation System driver:
20 $Pgm [command-line-options-and-input-files]
22 ------------------------------------------------------------------------
23 This driver ($Pgm) guides each input file through (some of the)
24 possible phases of a compilation:
26 - unlit: extract code from a "literate program"
27 - hscpp: run code through the C pre-processor (if -cpp flag given)
28 - hsc: run the Haskell compiler proper
29 - gcc: run the C compiler (if compiling via C)
30 - as: run the assembler
33 For each input file, the phase to START with is determined by the
35 - .lhs literate Haskell: unlit
36 - .hs illiterate Haskell: hsc
37 - .hc C from the Haskell compiler: gcc
38 - .c C not from the Haskell compiler: gcc
39 - .s assembly language: as
40 - other passed directly to the linker: ld
42 If no files are given on the command line, input is taken from
43 standard input, and processing is as for an .hs file. (All output is
44 to stdout or stderr, however).
46 The phase at which to STOP processing is determined by a command-line
48 -E stop after generating preprocessed, de-litted Haskell (used in conjunction with -cpp)
49 -C stop after generating C (.hc output)
50 -S stop after generating assembler (.s output)
51 -c stop after generating object files (.o output)
53 Other commonly-used options are:
55 -O An `optimising' package of compiler flags, for faster code
57 -prof Compile for cost-centre profiling
58 (add -auto for automagic cost-centres on top-level functions)
60 -fglasgow-exts Allow Glasgow extensions (unboxed types, etc.)
62 -H14m Increase compiler's heap size
64 -M Output the Makefile rules recording the
65 dependencies of a list of Haskell files.
66 (ghc driver script calls upon the help of a
67 compatible mkdependHS script to do the actual
70 The User's Guide has more information about GHC's *many* options.
72 Given the above, here are some TYPICAL invocations of $Pgm:
74 # compile a Haskell module to a .o file, optimising:
76 # link three .o files into an executable called "test":
77 % $Pgm -o test Foo.o Bar.o Baz.o
78 # compile a Haskell module to C (a .hc file), using a bigger heap:
79 % $Pgm -C -H16m Foo.hs
80 # compile Haskell-produced C (.hc) to assembly language:
82 ------------------------------------------------------------------------
86 %************************************************************************
88 \section[Driver-init]{Initialisation}
90 %************************************************************************
92 The driver script need to be told where to find these executables, so
93 in the course of building the driver `executable', make-variables holding
94 these are prepended to the de-litted version of this file. The variables are:
99 HOSTPLATFORM TARGETPLATFORM
101 ProjectName ProjectVersion ProjectVersionInt ProjectPatchLevel
103 HscMajorVersion HscMinorVersion CcMajorVersion CcMinorVersion
107 bindir libdir libexecdir datadir
111 GHC_LIB_DIR GHC_RUNTIME_DIR GHC_UTILS_DIR GHC_INCLUDE_DIR
113 GHC_OPT_HILEV_ASM GhcWithNativeCodeGen
115 GHC_UNLIT GHC_HSCPP GHC_HSC GHC_SYSMAN
119 WAY_*_NAME WAY_*_REAL_OPTS
127 Establish what executables to run for the various phases, what the
128 default options are for those phases, and other similar boring stuff.
131 select(STDERR); $| = 1; select(STDOUT); # no STDERR buffering, please.
133 $TargetPlatform = $TARGETPLATFORM;
135 $TopPwd = "${TOP_PWD}";
136 $InstBinDirGhc = "${bindir}";
137 $InstLibDirGhc = "${libdir}";
139 # Normally the same as InstLibDirGhc, but we accommodate
140 # for it being separate.
142 $InstLibExecDirGhc = "${libexecdir}";
143 $InstDataDirGhc = "${datadir}";
145 $Status = 0; # just used for exit() status
148 # set up signal handler
149 sub quit_upon_signal { &tidy_up_and_die(1, ''); }
150 $SIG{'INT'} = 'quit_upon_signal';
151 $SIG{'QUIT'} = 'quit_upon_signal';
153 # where to get "require"d .prl files at runtime (poor man's dynamic loading)
154 # (use LIB, not DATA, because we can't be sure of arch-independence)
155 @INC = ( ( $INSTALLING ) ? $InstLibDirGhc
156 : "$TopPwd/${CURRENT_DIR}" );
158 if ( $ENV{'TMPDIR'} ) { # where to make tmp file names
159 $Tmp_prefix = ($ENV{'TMPDIR'} . "/ghc$$");
161 print STDERR "TMPDIR has not been set to anything useful!\n" if (${TMPDIR} eq '');
162 $Tmp_prefix ="${TMPDIR}/ghc$$"; # TMPDIR set via Makefile when booting..
163 $ENV{'TMPDIR'} = ${TMPDIR}; # set the env var as well
166 # Some shells run into real trouble when command line and environment
167 # gets big (e.g., cmd lines of >4K to /bin/sh causes havoc on our
168 # Solaris-2.5.1 boxes - even though sysconf(_SC_ARG_MAX) reports 1M ...).
169 # To work around any such */bin/sh* problems, we will scribble such
170 # awfully long command lines into a temp file and exec that temp file
171 # with $(REAL_SHELL) (don't use the SHELL variable directly as this
172 # will normally get you the wrong thing when the driver is invoked
173 # from within `make'). If the REAL_SHELL variable isn't set, you'll
174 # get SHELL. This is all a terrible hack. (in case you hadn't reached
175 # the same conclusion by now :-)
179 if ( ! $ENV{'REAL_SHELL'} ) {
180 $ENV{'REAL_SHELL'} = $ENV{'SHELL'};
183 @Files_to_tidy = (); # files we nuke in the case of abnormal termination
185 $Unlit = ( $INSTALLING ) ? "$InstLibExecDirGhc/unlit"
186 : "$TopPwd/${CURRENT_DIR}/${GHC_UNLIT}";
190 $Diff = $CONTEXT_DIFF;
195 $HsCpp = # but this is re-set to "cat" (after options) if -cpp not seen
196 ( $INSTALLING ) ? "$InstLibExecDirGhc/hscpp"
197 : "$TopPwd/${CURRENT_DIR}/${GHC_HSCPP}";
200 $HsC = ( $INSTALLING ) ? "$InstLibExecDirGhc/hsc"
201 : "$TopPwd/${CURRENT_DIR}/${GHC_HSC}";
203 # For PVM fiends only
204 $SysMan = ( $INSTALLING ) ? "$InstLibExecDirGhc/SysMan"
205 : "$TopPwd/${CURRENT_DIR}/${GHC_SYSMAN}";
210 # HsC_rts_flags: if we want to talk to the LML runtime system
211 # NB: we don't use powers-of-2 sizes, because this may do
212 # terrible things to cache behavior.
214 $Specific_heap_size = 6 * 1000 * 1000;
215 $Specific_stk_size = 1000 * 1000;
216 $Scale_sizes_by = 1.0;
220 The variables set by @setupOptFlags@ represent parts of the
221 -O/-O2/etc ``templates,'' which are filled in later, using these.
222 These are the default values, which may be changed by user flags.
226 $Oopt_MaxSimplifierIterations = '-fmax-simplifier-iterations4';
227 $Oopt_PedanticBottoms = '-fpedantic-bottoms'; # ON by default
228 $Oopt_FinalStgProfilingMassage = '';
230 $Oopt_DoSpecialise = '-fspecialise';
231 $Oopt_FoldrBuild = 0; # *Off* by default!
232 $Oopt_UsageSPInf = ''; # Off by default
233 } # end of setupOptFlags
235 # Assign defaults to these right away.
239 Things to do with C compilers/etc:
241 (added -Wimplicit: implicit prototypes cause very hard-to-find
242 problems, so I'm turing on the warnings -- SDM 4/5/98)
245 $CcRegd = $GHC_OPT_HILEV_ASM;
246 @CcBoth_flags = ('-S','-Wimplicit'); # flags for *any* C compilation
250 # those for all files,
251 # those only for .c files;
252 # those only for .hc files
255 @CcRegd_flags_c = ();
256 @CcRegd_flags_hc = ();
258 $As = ''; # "assembler" is normally GCC
261 $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-binds',
286 '-fwarn-unused-imports');
287 @MinusWallOpts = (@MinusWOpts,
288 '-fwarn-unused-matches',
289 '-fwarn-type-defaults',
290 '-fwarn-name-shadowing',
291 '-fwarn-missing-signatures');
294 What options \tr{-user-setup-a} turn into (user-defined ``packages''
296 of options). Note that a particular user-setup implies a particular
297 Prelude ({\em including} its interface file(s)).
299 $BuildTag = ''; # default is sequential build w/ Appel-style GC
301 %BuildDescr = (# system ways begin
302 '', 'Normal Sequential',
304 '_t', "Ticky-ticky Profiling",
305 '_u', "Unregisterised",
325 '_B', "$WAY_B_NAME" );
327 # these are options that are "fed back" through the option processing loop
331 '_a', "$WAY_a_REAL_OPTS",
332 '_b', "$WAY_b_REAL_OPTS",
333 '_c', "$WAY_c_REAL_OPTS",
334 '_d', "$WAY_d_REAL_OPTS",
335 '_e', "$WAY_e_REAL_OPTS",
336 '_f', "$WAY_f_REAL_OPTS",
337 '_g', "$WAY_g_REAL_OPTS",
338 '_h', "$WAY_h_REAL_OPTS",
339 '_i', "$WAY_i_REAL_OPTS",
340 '_j', "$WAY_j_REAL_OPTS",
341 '_k', "$WAY_k_REAL_OPTS",
342 '_l', "$WAY_l_REAL_OPTS",
343 '_m', "$WAY_m_REAL_OPTS",
344 '_n', "$WAY_n_REAL_OPTS",
345 '_o', "$WAY_o_REAL_OPTS",
346 '_A', "$WAY_A_REAL_OPTS",
347 '_B', "$WAY_B_REAL_OPTS",
350 '_p', "-fscc-profiling -DPROFILING -optc-DPROFILING",
351 '_t', "-fticky-ticky -DTICKY_TICKY -optc-DTICKY_TICKY",
352 '_u', "-optc-DNO_REGS -optc-DUSE_MINIINTERPRETER -fno-asm-mangling -funregisterised",
353 '_mp', "-fstack-check -fparallel -D__PARALLEL_HASKELL__ -optc-DPAR",
354 '_mg', "-fstack-check -fconcurrent -fgransim -D__GRANSIM__ -D__CONCURRENT_HASKELL__ -optc-DCONCURRENT -optc-DGRAN");
356 # where to look for interface files (system hi's, i.e., prelude and syslibs)
357 @SysImport_dir = ( $INSTALLING )
358 ? ( "$InstLibDirGhc/imports/std" )
359 : ( "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/std" );
361 # We need to look in ghc/ and glaExts/ when searching for implicitly needed .hi files, but
362 # we should really *not* look there for explicitly imported modules.
364 $Haskell1Version = 5; # i.e., Haskell 1.4
367 # Cpp symbols defined when we're processing Haskell source.
370 ( "-D__HASKELL1__=$Haskell1Version"
371 , "-D__GLASGOW_HASKELL__=$ProjectVersionInt"
373 , "-D__CONCURRENT_HASKELL__"
377 @SysLibrary_dir = ( ( $INSTALLING ) #-syslib things supplied by the system
379 : ( "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR"
380 , "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR/gmp"
381 , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/std"
382 , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/std/cbits"
386 $TopClosureFile # defaults to 1.2 one; will be mangled later
388 # ( $INSTALLING) ? "$InstLibDirGhc/TopClosureXXXX.o"
389 # : "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR/main/TopClosureXXXX.o";
391 # make depend for Haskell
393 = ( $INSTALLING ) ? "$InstLibExecDirGhc/mkdependHS"
394 : "$TopPwd/$CURRENT_DIR/$GHC_UTILS_DIR/mkdependHS/mkdependHS";
396 @MkDependHS_flags = ();
398 # do_link flag should not be reset while rescanning the cmd-line.
400 $Specific_output_dir = ''; # set by -odir <dir>
401 $Specific_output_file = ''; # set by -o <file>; "-" for stdout
404 Function to initialise the per-compilation-unit globals that
405 are used to guide and control the invocation of the different phases.
408 sub initDriverGlobals {
410 # reset the following options:
411 # RTS flags to use while compiling
417 The optimisations/etc to be done by the compiler are {\em normally}
418 expressed with a \tr{-O} (or \tr{-O2}) flag, or by its absence.
421 $OptLevel = 0; # no -O == 0; -O == 1; -O2 == 2; -Ofile == 3
422 $MinusO2ForC = 0; # set to 1 if -O2 should be given to C compiler
423 $StolenX86Regs = 4; # **HACK*** of the very worst sort
428 @Import_dir = ('.'); #-i things
429 @Include_dir = ('.'); #-I things; other default(s) stuck on AFTER option processing
431 @UserLibrary_dir= (); #-L things;...
432 @UserLibrary = (); #-l things asked for by the user
434 @SysLibrary = (); # will be built up as we go along
437 We are given a list of files with various presumably-known suffixes
438 (unknown-suffix files go straight to the linker). For each file, we
439 begin by assuming that we'll run every phase over it. However: (1)
440 global flags (\tr{-c}, \tr{-S}, etc.) tell us not to run any phase
441 past a certain point; and (2) the file's suffix tells us what phase to
442 start with. Linking is weird and kept track of separately.
444 Here are the initial defaults applied to all files:
446 $Cpp_flag_set = 0; # (hack)
447 $Only_preprocess_C = 0; # pretty hackish
448 $Only_preprocess_hc = 0; # ditto
449 $Only_generate_deps = 0; # ""
450 $Only_generate_dll = 0;
451 $PostprocessCcOutput = 0;
454 # static = 0 => produce code for DLLs (when compiling & linking.)
456 $Static = 0 if ($EnableWin32DLLs eq 'YES');
458 # native code-gen or via C?
459 $HaveNativeCodeGen = $GhcWithNativeCodeGen;
460 $HscOut = '-C='; # '-C=' ==> .hc output; '-S=' ==> .s output; '-N=' ==> neither
462 if ($HaveNativeCodeGen ne 'YES') && $TargetPlatform =~ /^(alpha)-/;
463 # TEMP: disable x86 & Sparc if $HaveNativeCodeGen && $TargetPlatform =~ /^(i386|alpha|sparc)-/;
464 $ProduceHi = '-hifile=';
470 $CollectingGCstats = 0;
471 $CollectGhcTimings = 0;
472 $DEBUGging = ''; # -DDEBUG and all that it entails (um... not really)
473 $PROFing = ''; # set to p or e if profiling
474 $PROFgroup = ''; # set to group if an explicit -Ggroup specified
475 $PROFauto = ''; # set to relevant hsc flag if -auto or -auto-all
476 $PROFcaf = ''; # set to relevant hsc flag if -caf-all
477 $PROFdict = ''; # set to relevant hsc flag if -auto-dicts
478 $PROFignore_scc = ''; # set to relevant parser flag if explicit sccs ignored
479 $UNPROFscc_auto = ''; # set to relevant hsc flag if forcing auto sccs without profiling
480 $TICKYing = ''; # set to t if compiling for ticky-ticky profiling
481 $PARing = ''; # set to p if compiling for PAR
482 $GRANing = ''; # set to g if compiling for GRAN
483 $UNREGing = ($GhcWithRegisterised eq 'YES') ? '' : 'u';
484 $Specific_hi_file = ''; # set by -ohi <file>; "-" for stdout
485 $Specific_dump_file = ''; # set by -odump <file>; "-" for stdout
486 $Using_dump_file = 0;
488 $Osuffix = ''; # default: use the normal suffix for that kind of output
490 $HiSuffix_prelude = '';
492 $Do_recomp_chkr = 0; # don't use the recompilatio checker unless asked
493 $Do_cc = -1; # a MAGIC indeterminate value; will be set to 1 or 0.
496 $Keep_hc_file_too = 0;
497 $Keep_s_file_too = 0;
498 $UseGhcInternals = 0; # if 1, may use GHC* modules
500 $DoAsmMangling = 1; # on by default, off by -fno-asm-mangling
502 $Dump_parser_output = 0;
504 $Dump_asm_splitting_info = 0;
505 $NoImplicitPrelude = 0;
506 # 1 => don't tell the linker to hoist in PrelMain.Main, as an
507 # external main is provided instead.
510 } # end of initDriverGlobals (Sigh)
512 # we split the argv passed to the driver into three:
517 # and files to be linked...
523 # cmd line options prefixing the unit we're compiling
528 We inject consistency-checking information into \tr{.hc} files (both
529 when created by the Haskell compiler and when compiled by the C
530 compiler), so that we can check that an executable is made from
531 consistently-built pieces. (The check is normally done just after
532 linking.) The checking is done by introducing/munging
533 \tr{what(1)}-style strings. Anyway, here are the relevant global
534 variables and their defaults:
536 $LinkChk = 0; # set to 0 if the link check should *not* be done
538 # major & minor version numbers; major numbers must always agree;
539 # minor disagreements yield a warning.
540 $HsC_major_version = $HscMajorVersion;
541 $HsC_minor_version = $HscMinorVersion;
542 $Cc_major_version = $CcMajorVersion;
543 $Cc_minor_version = $CcMinorVersion;
545 # options: these must always agree
546 $HsC_consist_options = ''; # we record, in this order:
547 # Build tag; debugging?
548 $Cc_consist_options = ''; # we record, in this order:
549 # Build tag; debugging?
552 %************************************************************************
554 \section[Driver-parse-argv]{Munge the command-line options}
556 %************************************************************************
558 Now slurp through the arguments.
561 &initDriverGlobals();
562 &splitCmdLine(@ARGV);
563 # Run through the cmd-line first time.
564 &processArgs(@Cmd_opts);
566 # Check to see if driver is only in the business
567 # to generate dependencies
568 if ( $Status == 0 && $Only_generate_deps ) {
570 push (@MkDependHS_flags, "-o$Osuffix") if $Osuffix;
571 push (@MkDependHS_flags, "-s$BuildTag") if $BuildTag;
572 # They're not (currently) needed, but we need to quote any -#include options
573 foreach (@Cmd_opts) {
574 s/-#include.*$/'$&'/g;
576 local($to_do) = "$MkDependHS @MkDependHS_flags @HsSourceCppOpts -- @Cmd_opts -- @Input_file" ;
577 &run_something($to_do, 'Haskell dependencies');
581 # ..or just to construct a (Haskell) DLL.
582 if ( $Status == 0 && $Only_generate_dll && $EnableWin32DLLs ) {
588 # if there are several input files,
589 # we don't allow \tr{-o <file>} or \tr{-ohi <file>} options...
590 # (except if linking, of course)
592 if ($#Input_file > 0 && ( ! $Do_lnkr )) {
593 if ( ($Specific_output_file ne '' && $Specific_output_file ne '-')
594 || ($Specific_hi_file ne '' && $Specific_hi_file ne '-') ) {
595 print STDERR "$Pgm: You can't use -o or -ohi options if you have multiple input files.\n";
596 print STDERR "\tPerhaps the -odir option will do what you want.\n";
601 # check for various pathological -o and -odir combinations...
602 if ($Specific_output_dir ne '' && $Specific_output_file ne '') {
603 if ($Specific_output_file eq '-') {
604 print STDERR "$Pgm: can't set output directory with -ohi AND have output to stdout\n";
606 } else { # amalgamate...
607 $Specific_output_file = "$Specific_output_dir/$Specific_output_file";
608 # ToDo: check we haven't got a junk name now...
609 $Specific_output_dir = ''; # reset
613 # crash and burn if there were errors
615 print STDERR $ShortUsage;
620 %************************************************************************
622 \section[Driver-post-argv-mangling]{Setup after reading options}
624 %************************************************************************
626 %************************************************************************
628 \subsection{Set up for optimisation level (\tr{-O} or whatever)}
630 %************************************************************************
632 We come now to the default ``wads of options'' that are turned on by
633 \tr{-O0} (do min optimisation), \tr{-O} (ordinary optimisation),
634 \tr{-O2} (aggressive optimisation), or no O-ish flag (compile speed is
637 The user can also specify his/her own list of options in a file; in
638 that case, the work is already done (see stuff about @minusO3@,
641 GHC allows very precise control of what happens during a compilation.
642 Core-to-Core and STG-to-STG passes can be run in any order, as many
643 times as you like. Individual transformations can be turned on or
646 Sadly, however, there are some interdependencies \& Things You Must
647 Not Do. Here is the list.
651 \item[\tr{-fspecialise}:]
652 The specialiser must have dependency-analysed input; but if you run
653 the simplifier to do this, you must not let it toss away unused
654 bindings! (The typechecker conveys some specialisation info via
655 ``unused'' bindings...)
657 \item[\tr{-ffloat-inwards}:]
658 Floating inwards should be done before strictness analysis, because
659 the latter will give better results.
661 \item[\tr{-fstatic-args}:]
662 The static-arguments-transformation pass {\em must} have the
663 simplifier run right after it.
665 \item[\tr{-fcalc-inlinings[12]}:]
666 Not required, but there may be slight gains by re-simplifying after
667 this is done. (You could then \tr{-fcalc-inlinings} again, just for
670 \item[\tr{-ffull-laziness}:]
671 The (outwards-)let-floater should be the {\em last} Core-to-Core pass
672 that's run. (Um, well, howzabout the simplifier just once more...)
677 \item[\tr{-fupdate-analysis}:]
678 It really really wants to be the last STG-to-STG pass that is run.
683 sub setupOptimiseFlags {
685 # this pass-ordering sequence was agreed by Simon and Andr\'e
686 # (WDP 94/07, 94/11).
693 $Oopt_MaxSimplifierIterations,
697 $Oopt_FinalStgProfilingMassage
700 @HsC_minusO_flags # NOTE: used for *both* -O and -O2 (some conditional bits)
704 '-fdo-eta-reduction',
706 '-fdo-lambda-eta-expansion',
710 $Oopt_PedanticBottoms,
712 # initial simplify: mk specialiser happy: minimum effort please
716 '-finline-phase0', # Don't inline anything till full laziness has bitten
717 # In particular, inlining wrappers inhibits floating
718 # e.g. ...(case f x of ...)...
719 # ==> ...(case (case x of I# x# -> fw x#) of ...)...
720 # ==> ...(case x of I# x# -> case fw x# of ...)...
721 # and now the redex (f x) isn't floatable any more
722 '-fmax-simplifier-iterations2',
725 # Specialisation is best done before full laziness
726 # so that overloaded functions have all their dictionary lambdas manifest
727 ($Oopt_DoSpecialise) ? ( $Oopt_DoSpecialise, ) : (),
733 # # Run the simplifier before specialising, so that overloaded functions
734 # # look like f = \d -> ...
735 # # (Full laziness may lift out something hiding the \d
737 # '-fmax-simplifier-iterations1',
744 # Want to run with inline phase 1 after the specialiser to give
745 # maximum chance for fusion to work before we inline build/augment
746 # in phase 2. This made a difference in 'ansi' where an overloaded
747 # function wasn't inlined till too late.
748 $Oopt_MaxSimplifierIterations,
751 $Oopt_UsageSPInf, # infer usage information here in case we need it later.
752 # (add more of these where you need them --KSW 1999-04)
756 # Need inline-phase2 here so that build/augment get
757 # inlined. I found that spectral/hartel/genfft lost some useful
758 # strictness in the function sumcode' if augment is not inlined
759 # before strictness analysis runs
762 $Oopt_MaxSimplifierIterations,
772 $Oopt_MaxSimplifierIterations,
773 # No -finline-phase: allow all Ids to be inlined now
776 '-fcse', # CSE must immediately follow a simplification pass, because it relies
777 # on the no-shadowing invariant. See comments at the top of CSE.lhs
781 # Case-liberation for -O2. This should be after
782 # strictness analysis and the simplification which follows it.
786 # : "-fliberate-case -fsimplify [ $Oopt_FB_Support -ffloat-lets-exposing-whnf -ffloat-primops-ok -fcase-of-case -fdo-case-elim -fcase-merge -fdo-lambda-eta-expansion -freuse-con -flet-to-case $Oopt_PedanticBottoms $Oopt_MaxSimplifierIterations $Oopt_ShowSimplifierProgress ]" ),
788 # Final clean-up simplification:
792 $Oopt_MaxSimplifierIterations,
793 # No -finline-phase: allow all Ids to be inlined now
800 $Oopt_FinalStgProfilingMassage,
806 # SPECIAL FLAGS for -O2
808 '-fupdate-analysis', # virtually useless; relegated to -O2
815 Sort out what we're going to do about optimising. First, the @hsc@
816 flags and regular @cc@ flags to worry about:
818 if ( $OptLevel <= 0 ) {
820 # for this level, we tell the parser -fignore-interface-pragmas
821 push(@HsC_flags, '-fignore-interface-pragmas');
822 # and tell the compiler not to produce them
823 push(@HsC_flags, '-fomit-interface-pragmas');
825 &add_Hsc_flags( @HsC_minusNoO_flags );
826 push(@CcBoth_flags, ($MinusO2ForC) ? '-O2' : '-O'); # not optional!
828 } elsif ( $OptLevel == 1 || $OptLevel == 2 ) {
830 &add_Hsc_flags( @HsC_minusO_flags );
831 push(@CcBoth_flags, ($MinusO2ForC || $OptLevel == 2) ? '-O2' : '-O'); # not optional!
832 # -O? to GCC is not optional! -O2 probably isn't worth it generally,
833 # but it *is* useful in compiling the garbage collector.
835 } else { # -Ofile, then...
837 &add_Hsc_flags( @HsC_minusO3_flags );
838 push(@HsC_flags, $Oopt_FinalStgProfilingMassage) if $Oopt_FinalStgProfilingMassage;
840 push(@CcBoth_flags, ($MinusO2ForC) ? '-O2' : '-O'); # possibly to be elaborated...
843 } # setupOptimiseFlags
847 %************************************************************************
849 \subsection{Check for consistency, etc.}
851 %************************************************************************
853 Sort out @$BuildTag@, @$PROFing@, @$PARing@,
854 @$GRANing@, @$TICKYing@, @UNREGing@:
856 sub setupBuildFlags {
859 # PROFILING stuff after argv mangling:
861 # add -auto sccs even if not profiling !
862 push(@HsC_flags, $UNPROFscc_auto) if $UNPROFscc_auto;
865 push(@HsC_flags, $PROFauto) if $PROFauto;
866 push(@HsC_flags, $PROFcaf) if $PROFcaf;
867 push(@HsC_flags, $PROFdict) if $PROFdict;
869 $Oopt_FinalStgProfilingMassage = '-fmassage-stg-for-profiling';
871 # Ignore user sccs when auto annotating, but warn when doing so.
872 $PROFignore_scc = '-W' if $PROFauto;
874 #if ( $BuildTag ne '' ) {
875 # local($b) = $BuildDescr{$BuildTag};
876 # if ($PARing eq 'p') { print STDERR "$Pgm: Can't mix $b with -parallel.\n"; exit 1; }
877 # if ($GRANing eq 'g') { print STDERR "$Pgm: Can't mix $b with -gransim.\n"; exit 1; }
878 # if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix $b with -ticky.\n"; exit 1; }
880 # # ok to have a user-way profiling build
881 # # eval the profiling opts ... but leave user-way BuildTag
882 # if ($PROFing eq 'p') { &processArgs(split(' ', $SetupOpts{'_p'})); } # eval($EvaldSetupOpts{'_p'}); }
884 if ( $PROFing eq 'p' ) {
885 if ($PARing eq 'p') { print STDERR "$Pgm: Can't do profiling with -parallel.\n"; exit 1; }
886 if ($GRANing eq 'g') { print STDERR "$Pgm: Can't do profiling with -gransim.\n"; exit 1; }
887 if ($TICKYing eq 't') { print STDERR "$Pgm: Can't do profiling with -ticky.\n"; exit 1; }
890 } elsif ( $PARing eq 'p' ) {
891 if ($GRANing eq 'g') { print STDERR "$Pgm: Can't mix -parallel with -gransim.\n"; exit 1; }
892 if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix -parallel with -ticky.\n"; exit 1; }
895 if ( $Do_lnkr && ( ! $ENV{'PVM_ROOT'} || ! $ENV{'PVM_ARCH'} )) {
896 print STDERR "$Pgm: both your PVM_ROOT and PVM_ARCH environment variables must be set for linking under -parallel.\n";
900 } elsif ( $GRANing eq 'g' ) {
901 if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix -gransim with -ticky.\n"; exit 1; }
904 } elsif ( $TICKYing eq 't' ) {
907 } elsif ( $UNREGing eq 'u' ) {
908 if ($GhcWithRegisterised eq 'YES') {
914 After the sanity checks, add flags to the necessary parts of the driver pipeline:
917 if ( $BuildTag ne '' ) { # something other than normal sequential...
919 local($Tag) = "${BuildTag}";
920 $Tag =~ s/_//; # move the underscore to the back
922 $HscOut = '-C='; # must go via C
923 &processArgs(split(' ', $SetupOpts{$BuildTag}));
924 # eval($EvaldSetupOpts{$BuildTag});
928 Decide what the consistency-checking options are in force for this run:
931 $HsC_consist_options = "${BuildTag},${DEBUGging}";
932 $Cc_consist_options = "${BuildTag},${DEBUGging}";
935 # Funny place to put it, but why not.
937 if ( $HiSuffix_prelude eq '' ) {
939 if ($CompilingPrelude) {
940 $HiSuffix_prelude = "$HiSuffix" if $CompilingPrelude;
942 local($Tag) = "${BuildTag}";
945 $Tag = "${Tag}_" if $Tag ne '';
946 $HiSuffix_prelude="${Tag}hi";
952 %************************************************************************
954 \subsection{Add on machine-specific C-compiler flags}
956 %************************************************************************
958 Shove on magical machine-specific options. We use \tr{unshift} to
959 stick them on the {\em front} of the arrays, so that ``later''
960 user-specified flags can clobber them (e.g., \tr{-U__STG_REV_TBLS__}).
962 Note: a few ``always apply'' flags were set at the very beginning.
967 if ($TargetPlatform =~ /^alpha-/) {
968 unshift(@CcBoth_flags, ('-static'));
970 } elsif ($TargetPlatform =~ /^hppa/) {
971 unshift(@CcBoth_flags, ('-static'));
973 # We don't put in '-mlong-calls', because it's only
974 # needed for very big modules (sigh), and we don't want
975 # to hobble ourselves further on all the other modules
978 # [Dated comment (gcc-2.6.x?), -mlong-calls is no longer
979 # a supported gcc HPPA flag]
980 unshift(@CcBoth_flags, ('-D_HPUX_SOURCE'));
981 # ___HPUX_SOURCE, not _HPUX_SOURCE, is #defined if -ansi!
982 # (very nice, but too bad the HP /usr/include files don't agree.)
984 } elsif ($TargetPlatform =~ /^i386-/) {
985 # -fno-defer-pop : basically the same game as for m68k
987 # -fomit-frame-pointer : *must* in .hc files; because we're stealing
988 # the fp (%ebp) for our register maps.
990 unshift(@CcRegd_flags_hc, '-fno-defer-pop');
991 unshift(@CcRegd_flags_hc, '-fomit-frame-pointer');
992 unshift(@CcRegd_flags, "-DSTOLEN_X86_REGS=$StolenX86Regs");
994 unshift(@CcBoth_flags, ('-DDONT_WANT_WIN32_DLL_SUPPORT')) if ($Static);
996 } elsif ($TargetPlatform =~ /^m68k-/) {
997 # -fno-defer-pop : for the .hc files, we want all the pushing/
998 # popping of args to routines to be explicit; if we let things
999 # be deferred 'til after an STGJUMP, imminent death is certain!
1001 # -fomit-frame-pointer : *don't*
1002 # It's better to have a6 completely tied up being a frame pointer
1003 # rather than let GCC pick random things to do with it.
1004 # (If we want to steal a6, then we would try to do things
1005 # as on iX86, where we *do* steal the frame pointer [%ebp].)
1007 unshift(@CcRegd_flags_hc, '-fno-defer-pop');
1008 unshift(@CcRegd_flags, '-fno-omit-frame-pointer');
1009 # maybe gives reg alloc a better time
1010 # also: -fno-defer-pop is not sufficiently well-behaved without it
1012 } elsif ($TargetPlatform =~ /^mips-/) {
1013 unshift(@CcBoth_flags, ('-static'));
1015 } elsif ($TargetPlatform =~ /^powerpc-|^rs6000-/) {
1016 unshift(@CcBoth_flags, ('-static')); # always easier to start with
1017 unshift(@CcRegd_flags, ('-finhibit-size-directive')); # avoids traceback tables
1018 } elsif ($TargetPlatform =~ /^sparc-/) {
1020 } # end of setupMachOpts
1023 %************************************************************************
1025 \subsection{Set up for warnings}
1027 %************************************************************************
1029 Several warnings are turned on by default. These are supposed to be
1030 the 'I'm pretty sure you've made a mistake here' kind of warnings.
1031 The rest are turned on by the -W and -Wall options, or individually
1032 via their -fwarn and -fno-warn flags.
1035 sub setupWarningFlags {
1036 &add_Hsc_flags( @StandardWarnings );
1040 Same unshifting magic, but for special linker flags.
1042 The configure script determines whether the object file symbol tables
1043 have a leading underscore, and sets @LeadingUnderscore@ accordingly.
1044 (The driver script `sees' the setting of the @LeadingUnderscore@
1045 by having the Makefile prepend it).
1049 local($uscore) = ( ${LeadingUnderscore} eq 'YES' ) ? '_' : '';
1052 (($Ld_main) ? ( '-u', "${uscore}Main_" . $Ld_main . '_closure' ) : ()));
1054 # things that are referenced by the RTS - make sure that we pull 'em in
1056 ( '-u', "${uscore}PrelBase_Izh_static_info"
1057 ,'-u', "${uscore}PrelBase_Czh_static_info"
1058 ,'-u', "${uscore}PrelBase_Fzh_static_info"
1059 ,'-u', "${uscore}PrelBase_Dzh_static_info"
1060 ,'-u', "${uscore}PrelAddr_Azh_static_info"
1061 ,'-u', "${uscore}PrelAddr_Wzh_static_info"
1062 ,'-u', "${uscore}PrelAddr_I64zh_static_info"
1063 ,'-u', "${uscore}PrelAddr_W64zh_static_info"
1064 ,'-u', "${uscore}PrelStable_StablePtr_static_info"
1065 ,'-u', "${uscore}PrelBase_Izh_con_info"
1066 ,'-u', "${uscore}PrelBase_Czh_con_info"
1067 ,'-u', "${uscore}PrelBase_Fzh_con_info"
1068 ,'-u', "${uscore}PrelBase_Dzh_con_info"
1069 ,'-u', "${uscore}PrelAddr_Azh_con_info"
1070 ,'-u', "${uscore}PrelAddr_Wzh_con_info"
1071 ,'-u', "${uscore}PrelAddr_I64zh_con_info"
1072 ,'-u', "${uscore}PrelAddr_W64zh_con_info"
1073 ,'-u', "${uscore}PrelStable_StablePtr_con_info"
1074 ,'-u', "${uscore}PrelBase_False_static_closure"
1075 ,'-u', "${uscore}PrelBase_True_static_closure"
1076 ,'-u', "${uscore}PrelPack_unpackCString_closure"
1077 ,'-u', "${uscore}PrelException_stackOverflow_closure"
1078 ,'-u', "${uscore}PrelException_heapOverflow_closure"
1080 if (!$NoHaskellMain) {
1081 unshift (@Ld_flags,'-u', "${uscore}PrelMain_mainIO_closure");
1083 if ($TargetPlatform =~ /^powerpc-|^rs6000-/) {
1084 # sometimes we have lots of toc entries...
1085 # unshift(@Ld_flags, ('-Xlinker -bbigtoc -Xlinker -bnoquiet'));
1086 unshift(@Ld_flags, ('-Xlinker -bbigtoc'));
1090 } # end of setupLinkOpts
1094 %************************************************************************
1096 \subsection{Set up include paths and system-library enslurpment}
1098 %************************************************************************
1100 Now that we know what garbage-collector, etc., are required, we can
1101 finalise our list of libraries to slurp through, and generally Get
1106 # default includes must be added AFTER option processing
1107 if ( ! $INSTALLING ) {
1108 push (@Include_dir, "$TopPwd/${CURRENT_DIR}/${GHC_INCLUDE_DIR}");
1110 push (@Include_dir, "$InstLibDirGhc/includes");
1111 push (@Include_dir, "$InstLibDirGhc/includes");
1113 } # end of setupIncPaths
1118 push(@SysLibrary, ( '-lHS', '-lHS_cbits' )); # basic I/O and prelude stuff
1121 foreach $f (@SysLibrary) {
1122 next if $f =~ /_cbits/;
1123 $f .= $BuildTag if $f =~ /^-lHS/;
1126 # Push library HSrts, plus boring clib bit
1127 push(@SysLibrary, "-lHSrts${BuildTag}");
1130 # RTS compiled with cygwin32, uses the WinMM API
1131 # to implement the itimers, since cygwin.dll does not
1132 # support it. Only reqd. for `ways' that use itimers.
1134 push(@SysLibrary, '-lwinmm') if $TargetPlatform eq 'i386-unknown-cygwin32';
1135 # Note: currently only tested with mingw, may cause conflicts when linking
1137 push(@SysLibrary, '-lwsock32') if ($TargetPlatform =~ /-(mingw32|cygwin32)$/);
1139 # Push the pvm libraries
1140 if ($BuildTag eq '_mp') {
1141 $pvmlib = "$ENV{'PVM_ROOT'}/lib/$ENV{'PVM_ARCH'}";
1142 push(@SysLibrary, "-L$pvmlib", '-lgpvm3', '-lpvm3');
1143 if ( $ENV{'PVM_ARCH'} eq 'SUNMP' ) {
1144 push(@SysLibrary, '-lthread', '-lsocket', '-lnsl');
1145 } elsif ( $ENV{'PVM_ARCH'} eq 'SUN4SOL2' ) {
1146 push(@SysLibrary, '-lsocket', '-lnsl');
1150 # Push the GNU multi-precision arith lib; and the math library
1152 # If this machine has GMP already installed, then we'll get the installed
1153 # lib here, because presumably the one in the tree won't have been built.
1155 if ($LibGmp eq 'not-installed') {
1156 push(@SysLibrary, "-lgmp");
1158 push(@SysLibrary, "-l$LibGmp");
1161 push(@SysLibrary, '-lm') if !( $TargetPlatform =~ /^.*(cygwin32|mingw32)$/ );
1164 %************************************************************************
1166 \subsection{Check that this system was built to do what we are asking}
1168 %************************************************************************
1170 Before continuing we check that the appropriate build is available.
1173 #die "$Pgm: no BuildAvail?? $BuildTag\n" if $BuildDescr{$BuildTag} eq '' ; # sanity
1175 if ( $BuildDescr{$BuildTag} eq '' ) {
1176 print STDERR "$Pgm: a `", $BuildDescr{$BuildTag},
1177 "' \"build\" is not available with your GHC setup.\n";
1178 print STDERR "(It was not configured for it at your site.)\n";
1179 print STDERR $ShortUsage;
1183 } # end of setupSyslibs
1187 %************************************************************************
1189 \subsection{Final miscellaneous setup bits before we start going}
1191 %************************************************************************
1193 Record largest specific heapsize, if any.
1195 sub setupHeapStackSize {
1196 $Specific_heap_size = $Specific_heap_size * $Scale_sizes_by;
1197 push(@HsC_rts_flags, '-H'.$Specific_heap_size);
1198 $Specific_stk_size = $Specific_stk_size * $Scale_sizes_by;
1199 push(@HsC_rts_flags, "-K$Specific_stk_size");
1203 If no input or link files seen, then we let 'em feed in stdin; this is
1204 mainly for debugging.
1208 if ($#Input_file < 0 && $#Link_file < 0) {
1209 @Input_file = ( '-' );
1211 open(INF, "> $Tmp_prefix.hs") || &tidy_up_and_die(1,"Can't open $Tmp_prefix.hs\n");
1212 print STDERR "Enter your Haskell program, end with ^D (on a line of its own):\n" if -t;
1213 while (<STDIN>) { print INF $_; }
1214 close(INF) || &tidy_up_and_die(1,"Failed writing to $Tmp_prefix.hs\n");
1219 Tell the world who we are, if they asked.
1221 print STDERR "${ProjectName}, version ${ProjectVersion}, patchlevel ${ProjectPatchLevel}\n"
1225 %************************************************************************
1227 \section[Driver-main-loop]{Main loop: Process input files, and link if required}
1229 %************************************************************************
1231 Process the input files; don't continue with linking if there are
1232 problems (global variable @$Status@ non-zero).
1234 foreach $ifile (@Input_file) {
1235 &ProcessInputFile($ifile);
1238 # don't link if there were errors...
1239 if ( $Status > 0 ) {
1240 print STDERR $ShortUsage;
1245 # Link if appropriate.
1246 &runLinker() if $Do_lnkr;
1248 # that... that's all, folks!
1250 exit $Status; # will still be 0 if all went well
1253 %************************************************************************
1255 \section[Driver-do-one-file]{How to process a single input file}
1257 %************************************************************************
1260 sub ProcessInputFile {
1261 local($ifile) = @_; # input file name
1262 local($ifile_root); # root of or basename of input file
1263 local($ofile_target); # ultimate output file we hope to produce
1264 # from input file (need to know for recomp
1265 # checking purposes)
1266 local($hifile_target);# ditto (but .hi file)
1267 local($ofile_c_stub_target);
1268 local($ofile_h_stub_target);
1271 Handle the weirdity of input from stdin.
1273 if ($ifile ne '-') {
1274 ($ifile_root = $ifile) =~ s/\.[^\.\/]+$//;
1275 $ofile_target = # may be reset later...
1276 ($Specific_output_file ne '' && ! $Do_lnkr)
1277 ? $Specific_output_file
1278 : &odir_ify($ifile_root, 'o');
1279 $hifile_target= ($Specific_hi_file ne '')
1281 : "$ifile_root.$HiSuffix"; # ToDo: odirify?
1282 # NB: may change if $ifile_root isn't module name (??)
1283 ($ofile_c_stub_target = $ifile) =~s/\.[^\.\/]+$/_stub.c/;
1284 ($ofile_h_stub_target = $ifile) =~s/\.[^\.\/]+$/_stub.h/;
1286 $ifile = "$Tmp_prefix.hs"; # we know that's where we put the input
1287 $ifile_root = '_stdin';
1288 $ofile_target = '_stdout'; # gratuitous?
1289 $hifile_target= '_stdout'; # ditto?
1293 We need to decide what phases of the compilation system we will run
1294 over this file. The defaults are the ones established when processing
1295 flags. (That established what the last phase run for all files is.)
1297 We do the pre-recompilation-checker phases here; the rest later.
1301 Look at the suffix and decide what initial phases of compilation may
1302 be dropped off for this file. Also the rather boring business of
1303 which files are coming-in/going-out.
1305 Again, we'll do the post-recompilation-checker parts of this later.
1307 local($do_lit2pgm) = ($ifile =~ /\.lhs$/) ? 1 : 0;
1308 local($do_hscpp) = 1; # but "hscpp" might really be "cat"
1311 # names of the files to stuff between phases
1312 # defaults are temporaries
1313 local($in_lit2pgm) = $ifile;
1314 local($lit2pgm_hscpp) = "$Tmp_prefix.lpp";
1315 local($hscpp_hsc) = "$Tmp_prefix.cpp";
1316 local($hsc_hi) = "$Tmp_prefix.hi";
1317 local($cc_as_o) = "${Tmp_prefix}_o.s"; # temporary for raw .s file if opt C
1318 local($cc_as) = "$Tmp_prefix.s"; # mangled or hsc-produced .s code
1319 local($as_out) = $ofile_target;
1321 local($is_hc_file) = 1; #Is the C code .hc or .c? Assume .hc for now
1323 # OK, let's strip off some literate junk..
1325 &runLit2pgm($in_lit2pgm, $lit2pgm_hscpp)
1327 $lit2pgm_hscpp = $ifile;
1333 # Scan the top of the de-litted file for {-# OPTIONS #-} pragmas
1334 &check_for_source_options($lit2pgm_hscpp,$ifile);
1336 # Options found in the source file take a back seat, i.e., we scan
1337 # them first. Only process the command line again if source file
1338 # contained anything of interest *or* there's more than one
1339 # input file (we have to reset the options).
1341 if ( $#Input_file >= 0 || $#File_options >= 0) {
1342 #@File_options = (@File_options, @Cmd_opts);
1344 # Now process the command line
1345 &initDriverGlobals();
1346 &processArgs((@File_options,@Cmd_opts));
1347 print STDERR "\nEffective command line: " .
1348 join(' ',(@File_options,@Cmd_opts)) . "\n" if $Verbose;
1351 # Having got the effective command line scanned, set up
1352 # the various options in prep for some real work.
1354 # check the sanity of the BuildTag we're about to use,
1355 # and if needs be, add some more flags and setup to
1356 # the different phases.
1359 &setupOptimiseFlags();
1362 &setupWarningFlags();
1363 &setupHeapStackSize();
1366 # These two variables need to be set after the
1367 # command-line has been processed and the build options
1368 # have be seen set up. This is because command-line options
1369 # can control whether to compile vias C or not.
1371 local($do_cc) = ( $Do_cc != -1) # i.e., it was set explicitly
1373 : ( ($HscOut eq '-C=') ? 1 : 0 );
1374 local($do_as) = $Do_as;
1375 local($hsc_out) = ( $HscOut eq '-C=' ) ? "$Tmp_prefix.hc" : "$Tmp_prefix.s" ;
1376 local($hsc_out_c_stub) = ( $HscOut eq '-C=' ) ? "${Tmp_prefix}_stb.c" : "";
1377 local($hsc_out_h_stub) = ( $HscOut eq '-C=' ) ? "${Tmp_prefix}_stb.h" : "";
1379 if ($Only_preprocess_hc) { # stop after having run $Cc -E
1382 if ($Only_preprocess_C) { # stop after having run $hscpp
1383 $do_hsc=0; $do_cc = 0; $do_as=0;
1384 } elsif ($ifile =~ /.lhs$/ || $ifile =~ /.hs$/ ) {
1386 } elsif ($ifile =~ /\.hc$/ || $ifile =~ /_hc$/ ) { # || $ifile =~ /\.$Isuffix$/o) # ToDo: better
1387 $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
1389 $hsc_out_c_stub = '';
1390 $hsc_out_h_stub = '';
1391 } elsif ($ifile =~ /\.c$/) {
1392 $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
1393 $hsc_out = $ifile; $is_hc_file = 0;
1394 $hsc_out_c_stub = '';
1395 $hsc_out_h_stub = '';
1396 } elsif ($ifile =~ /\.[sS]$/) {
1397 $do_hscpp = 0; $do_hsc = 0; $do_cc = 0;
1399 } else { # don't know what it is, but nothing to do herein...
1400 $do_hscpp = 0; $do_hsc = 0; $do_cc = 0; $do_as = 0;
1403 # hack to avoid running hscpp
1404 $HsCpp = $Cat if ! $Cpp_flag_set;
1406 &runHscpp($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc) if $do_hscpp;
1410 We now think about whether to run hsc/cc or not (when hsc produces .s
1411 stuff, it effectively takes the place of both phases).
1412 To get the output file name right: for each phase that we are {\em
1413 not} going to run, set its input (i.e., the output of its preceding
1414 phase) to @"$ifile_root.<suffix>"@.
1417 local($going_interactive) = $HscOut eq '-N=' || $ifile_root eq '_stdin';
1420 # Warning issued if -keep-hc-file-too is used without
1421 # -fvia-C (or the equivalent)
1423 if ( $HscOut ne '-C=' && $Keep_hc_file_too ) {
1424 print STDERR "$Pgm: warning: Native code generator to be used, -keep-hc-file-too will be ignored\n";
1427 if (! $do_cc && ! $do_as) { # stopping after hsc
1428 $hsc_out = ($Specific_output_file ne '')
1429 ? $Specific_output_file
1430 : &odir_ify($ifile_root, ($HscOut eq '-C=') ? 'hc' : 's');
1432 $ofile_target = $hsc_out; # reset
1435 if (! $do_as) { # stopping after gcc (or hsc)
1436 $cc_as = ($Specific_output_file ne '')
1437 ? $Specific_output_file
1438 : &odir_ify($ifile_root, ( $Only_preprocess_hc ) ? 'i' : 's');
1440 $ofile_target = $cc_as; # reset
1446 Now the Haskell compiler, C compiler, and assembler
1450 &runHscAndProcessInterfaces( $ifile, $hscpp_hsc, $ifile_root,
1451 $ofile_target, $hifile_target,
1452 $going_interactive);
1455 if (-f $hsc_out_h_stub) {
1456 &run_something("cp $hsc_out_h_stub $ofile_h_stub_target", 'Copy foreign export header file');
1459 if (-f $hsc_out_c_stub) {
1460 &run_something("cp $hsc_out_c_stub $ofile_c_stub_target", 'Copy foreign export C stubs');
1461 local ($hsc_out_s_stub);
1462 local ($hsc_out_o_stub);
1463 ($ofile_s_stub_target = $ofile_c_stub_target) =~ s/\.(.*)$/\.s/;
1464 ($ofile_o_stub_target = $ofile_c_stub_target) =~ s/\.(.*)$/\.o/;
1465 &runGcc (0, $ofile_c_stub_target, $ofile_s_stub_target);
1466 &runAs ($ofile_o_stub_target, $ofile_s_stub_target);
1468 # Bring the C stub protos into scope when compiling the .hc file.
1470 push (@CcInjects, "#include \"${hsc_out_h_stub}\"\n");
1471 # Hack - ensure that the stub .h file is included in the OPTIONS section
1472 # if the .hc file is saved.
1473 push (@File_options, "-#include \"${ofile_h_stub_target}\"\n");
1478 &runGcc ($is_hc_file, $hsc_out, $cc_as_o);
1479 &runMangler($is_hc_file, $cc_as_o, $cc_as, $ifile_root) if ! $Only_preprocess_hc;
1482 &split_asm_file($cc_as) if $do_as && $SplitObjFiles;
1484 # save a copy of the .s file..
1485 &saveIntermediate($ifile_root , "s" , $cc_as) if ($do_as && $Keep_s_file_too);
1486 &runAs($as_out, $ifile_root) if $do_as;
1489 Finally, decide what to queue up for linker input.
1491 # tentatively assume we will eventually produce linker input:
1492 push(@Link_file, &odir_ify($ifile_root, 'o'));
1494 #ToDo: local($or_isuf) = ($Isuffix eq '') ? '' : "|$Isuffix";
1496 if ( $ifile !~ /\.(lhs|hs|hc|c|s|a|S)$/ && $ifile !~ /_hc$/ ) {
1497 # There's sometimes confusion regarding .hi files; users
1498 # supplying them on the command line.
1499 if ( $ifile =~ /\.hi$/ ) {
1500 print STDERR "$Pgm: warning: found `$ifile' on command line; interface files should not be supplied here - ignoring it.\n";
1502 print STDERR "$Pgm: don't recognise suffix on `$ifile'; passing it through to linker\n";
1504 # oops; we tentatively pushed the wrong thing; fix & do the right thing
1505 pop(@Link_file); push(@Link_file, $ifile);
1509 } # end of ProcessInputFile
1512 %************************************************************************
1514 \section[Driver-run-phases]{Routines to run the various phases}
1516 %************************************************************************
1520 local($in_lit2pgm, $lit2pgm_hscpp) = @_;
1524 # Only add #line pragma if we're going to need it.
1525 $to_do = "echo '#line 1 \"$in_lit2pgm\"' > $lit2pgm_hscpp && " if ($Cpp_flag_set);
1526 $to_do .= "$Unlit @Unlit_flags $in_lit2pgm - >> $lit2pgm_hscpp";
1528 push(@Files_to_tidy, $lit2pgm_hscpp );
1530 &run_something($to_do, 'literate pre-processor');
1536 local($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc) = @_;
1540 # Strictly speaking, echoing of the following line pragma is only required
1541 # on non-delit'ed input, as we've already added it during de-lit. However,
1542 # hscpp will then add a {-# LINE 1 "$lit2pgm_hsc" -} to the top of the file,
1543 # which is not very informative (but harmless). Hence, we uniformly have
1544 # {-# LINE 1 "$in_lit2pgm" #-} as the first line to all cpp'ed hsc input.
1546 $to_do = "echo '{-# LINE 1 \"$in_lit2pgm\" -}' > $hscpp_hsc && ";
1548 if ($HsCpp eq $Cat) {
1549 $to_do .= "$HsCpp $lit2pgm_hscpp >> $hscpp_hsc";
1550 push(@Files_to_tidy, $hscpp_hsc );
1551 &run_something($to_do, 'Ineffective C pre-processor');
1553 local($includes) = '-I' . join(' -I',@Include_dir);
1554 $to_do .= "$HsCpp $Verbose @HsCpp_flags @HsSourceCppOpts $includes $lit2pgm_hscpp >> $hscpp_hsc";
1555 push(@Files_to_tidy, $hscpp_hsc );
1556 &run_something($to_do, 'Haskellised C pre-processor');
1559 if ( $Only_preprocess_C ) {
1560 $to_do = "$Cat $hscpp_hsc";
1561 &run_something($to_do, '');
1569 sub runHscAndProcessInterfaces {
1570 local($ifile, $hscpp_hsc, $ifile_root,
1571 $ofile_target, $hifile_target,
1572 $going_interactive) = @_;
1574 # $ifile is the original input file
1575 # $hscpp_hsc post-unlit, post-cpp, etc., input file
1576 # $ifile_root input filename minus suffix
1577 # $ofile_target the output file that we ultimately hope to produce
1578 # $hifile_target the .hi file ... (ditto)
1580 local($source_unchanged) = 1;
1582 # Check if the source file is up to date relative to the target; in
1583 # that case we say "source is unchanged" and let the compiler bail out
1584 # early if the import usage information allows it.
1586 ($i_dev,$i_ino,$i_mode,$i_nlink,$i_uid,$i_gid,$i_rdev,$i_size,
1587 $i_atime,$i_mtime,$i_ctime,$i_blksize,$i_blocks) = stat($ifile);
1589 # The informational messages below are now conditional on -v being set -- SOF
1590 if ( $ofile_target ne "_stdin.s" && ! -f $ofile_target ) {
1591 print STDERR "$Pgm:compile:Output file $ofile_target doesn't exist\n" if $Verbose;
1592 $source_unchanged = 0;
1595 ($o_dev,$o_ino,$o_mode,$o_nlink,$o_uid,$o_gid,$o_rdev,$o_size,
1596 $o_atime,$o_mtime,$o_ctime,$o_blksize,$o_blocks) = stat(_); # stat info from -f test
1598 if ( $hifile_target ne "_stdout" && ! -f $hifile_target ) {
1599 print STDERR "$Pgm:compile:Interface file $hifile_target doesn't exist\n" if $Verbose;
1600 $source_unchanged = 0;
1603 ($hi_dev,$hi_ino,$hi_mode,$hi_nlink,$hi_uid,$hi_gid,$hi_rdev,$hi_size,
1604 $hi_atime,$hi_mtime,$hi_ctime,$hi_blksize,$hi_blocks) = stat(_); # stat info from -f test
1606 if ( $ofile_target ne "_stdin.s" && $i_mtime > $o_mtime) {
1607 print STDERR "$Pgm:recompile:Input file $ifile newer than $ofile_target\n" if $Verbose;
1608 $source_unchanged = 0;
1611 # Tell the compiler which version we're using
1612 push(@HsC_flags, "-fhi-version=${ProjectVersionInt}");
1614 # So if source_unchanged is still "1", we pass on the good news to the compiler
1615 # The -recomp flag can disable this, forcing recompilation
1616 if ($Do_recomp_chkr && $source_unchanged) {
1617 push(@HsC_flags, '-fsource-unchanged');
1620 # Indicate whether we're static or not.
1621 # This will only ever
1622 push(@HsC_flags, '-static') if $Static;
1626 &runHsc($ifile_root, $hsc_out, $hsc_hi, $hsc_out_c_stub, $hsc_out_h_stub, $going_interactive);
1628 # See if it bailed out early, saying nothing needed doing.
1629 # We work this out by seeing if it created an output .hi file
1631 if ( ! -f $hsc_hi && $ProduceHi !~ /-nohifile=/ ) {
1632 # Doesn't exist, so we bailed out early.
1633 # Tell the C compiler and assembler not to run
1634 $do_cc = 0; $do_as = 0;
1636 # Update dependency info, touch both object file and
1637 # interface file, so that the following invariant is
1640 # a dependent module's interface file should after recompilation
1641 # checking be newer than the interface files of its imports.
1643 # That is, if module A's interface file changes, then module B
1644 # (which import from A) needs to be checked.
1645 # If A's change does not affect B, which causes the compiler to bail
1646 # out early, we still need to touch the interface file of B. The reason
1647 # for this is that B may export A's interface.
1649 &run_something("touch $ofile_target",
1650 "Touch $ofile_target, to propagate dependencies") if $HscOut ne '-N=';
1651 &run_something("touch $hifile_target",
1652 "Touch $hifile_target, to propagate dependencies") if $ProduceHi =~ /-nohifile=/ ;
1656 # Didn't bail out early (new .hi file) so we thunder on
1658 # If non-interactive, heave in the consistency info at the end
1659 # NB: pretty hackish (depends on how $output is set)
1660 if ( ! $going_interactive ) {
1661 if ( $HscOut eq '-C=' ) {
1662 $to_do = "echo 'static char ghc_hsc_ID[] = \"\@(#)hsc $ifile\t$HsC_major_version.$HsC_minor_version,$HsC_consist_options\";' >> $hsc_out";
1664 } elsif ( $HscOut eq '-S=' ) {
1665 local($consist) = "hsc.$ifile.$HsC_major_version.$HsC_minor_version.$HsC_consist_options";
1666 $consist =~ s/,/./g;
1667 $consist =~ s/\//./g;
1668 $consist =~ s/-/_/g;
1669 $consist =~ s/[^A-Za-z0-9_.]/ZZ/g; # ToDo: properly?
1670 $to_do = "echo '\n\t.text\n$consist:' >> $hsc_out";
1672 &run_something($to_do, 'Pin on Haskell consistency info');
1676 # Interface-handling is important enough to live off by itself
1677 if ( $ProduceHi !~ /-nohifile=/ ) { # If we've produced one, process it.
1678 require('ghc-iface.prl') || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-iface.prl!\n");
1679 &postprocessHiFile($hsc_hi, $hifile_target, $going_interactive);
1681 # if we're going to split up object files,
1682 # we inject split markers into the .hc file now
1683 if ( $HscOut eq '-C=' && $SplitObjFiles ) {
1684 &inject_split_markers ( $hsc_out );
1687 # save a copy of the .hc file, even if we are carrying on...
1688 if ($HscOut eq '-C=' && $do_cc && $Keep_hc_file_too) {
1689 &saveIntermediate($ifile_root , "hc" , $hsc_out);
1699 local($ifile_root, $hsc_out, $hsc_hi, $hsc_out_c_stub, $hsc_out_h_stub, $going_interactive) = @_;
1701 &makeHiMap() unless $HiMapDone;
1702 push(@HsC_flags, "-himap=$HiIncludeString");
1704 # here, we may produce .hc/.s and/or .hi files
1705 local($output) = '';
1706 #@Files_to_tidy = ();
1708 if ( $going_interactive ) {
1709 # don't need .hi unless we're going to show it on stdout:
1710 $ProduceHi = '-nohifile=' if ! ($HiOnStdout || $Specific_hi_file ne '' );
1711 $do_cc = 0; $do_as = 0; $Do_lnkr = 0; # and we won't go any further...
1714 # set up for producing output/.hi; note that flag twiddling
1715 # may mean that nothing will actually be produced:
1716 $output = "$ProduceHi$hsc_hi $HscOut$hsc_out -F=$hsc_out_c_stub -FH=$hsc_out_h_stub";
1717 push(@Files_to_tidy, $hsc_hi, $hsc_out, $hsc_out_c_stub, $hsc_out_h_stub );
1719 # if we're compiling foo.hs, we want the GC stats to end up in foo.stat
1720 if ( $CollectingGCstats ) {
1721 push(@HsC_rts_flags, "-S$ifile_root.stat");
1722 push(@Files_to_tidy, "$ifile_root.stat");
1725 if ( $CollectGhcTimings ) { # assume $RTS_style eq 'ghc'
1726 # emit nofibbish time/bytes-alloc stats to stderr;
1727 # see later .stat file post-processing
1728 print STDERR "warning: both -Rgc-stats and -Rghc-timing used, -Rghc-timing wins." if $CollectingGCstats;
1729 push(@HsC_rts_flags, "-s$Tmp_prefix.stat");
1730 push(@Files_to_tidy, "$Tmp_prefix.stat");
1734 if ($Specific_dump_file ne '') {
1735 $dump = "2>> $Specific_dump_file";
1736 $Using_dump_file = 1;
1740 # Win32 only: If the command processor used by system()
1741 # exec()s the application as an ordinary Win32 executable,
1742 # we're in trouble here, since the command line is likely
1743 # to be > 255 chars long. To work around this situation,
1744 # $HsC also understands `at-files', i.e., `@file' on the
1745 # command line will cause $HsC to add the contents of `file'
1746 # to the command line.
1748 # [ Note: support for `at-files' is not compiled in by default ]
1749 $cmd_line_opts_via_at_file=0;
1750 if ($cmd_line_opts_via_at_file) {
1752 local($to_do_opts) = "$Tmp_prefix.opts";
1753 open(OPTS, "> $Tmp_prefix.opts") || &tidy_up_and_die(1,"Can't open $Tmp_prefix.opts\n");
1754 print OPTS "$dump @HsC_flags $CoreLint $USPLint $StgLint $Verbose";
1756 $to_do = "$HsC $hscpp_hsc \@$Tmp_prefix.opts $output +RTS @HsC_rts_flags";
1760 $to_do = "$HsC $hscpp_hsc $dump @HsC_flags $CoreLint $USPLint $StgLint $Verbose $output +RTS @HsC_rts_flags";
1762 &run_something($to_do, 'Haskell compiler');
1764 # finish business w/ nofibbish time/bytes-alloc stats
1765 &process_ghc_timings() if $CollectGhcTimings;
1769 Use \tr{@Import_dir} and \tr{@SysImport_dir} to make a tmp file
1770 of (module-name, pathname) pairs, one per line, separated by a space.
1773 $HiIncludeString = (); # dir1:dir2:dir3, to pass to GHC
1777 # collect in %HiMap; write later; also used elsewhere in driver
1779 local($mod, $path, $d, $e);
1781 # reset the global variables:
1783 $HiIncludeString = (); # dir1:dir2:dir3, to pass to GHC
1785 foreach $d ( @Import_dir ) {
1786 if ($HiIncludeString) {
1787 $HiIncludeString = "$HiIncludeString:${d}%.${HiSuffix}";
1789 $HiIncludeString = "$d%.${HiSuffix}";
1794 foreach $d ( @SysImport_dir ) {
1795 if ($HiIncludeString) {
1796 $HiIncludeString = "$HiIncludeString:${d}%.${HiSuffix_prelude}";
1798 $HiIncludeString = "${d}%.${HiSuffix_prelude}";
1807 Invoke the 'linker' - either the standard linker or the one used to build
1813 local($libdirs) = '';
1815 # append last minute flags linker and consistency flags
1820 # glue them together:
1821 push(@UserLibrary_dir, @SysLibrary_dir);
1823 $libdirs = '-L' . join(' -L',@UserLibrary_dir) if $#UserLibrary_dir >= 0;
1825 # for a linker, use an explicitly given one, or the going C compiler ...
1826 local($lnkr) = ( $Lnkr ) ? $Lnkr : $CcRegd;
1828 if ( ($Specific_output_file eq '') &&
1829 ($TargetPlatform eq 'i386-unknown-cygwin32') ) {
1830 $Specific_output_file = 'main.exe';
1831 print STDERR "Output file not specified, defaulting to \"main.exe\"\n";
1834 local($output) = ($Specific_output_file ne '') ? "-o $Specific_output_file" : '';
1835 @Files_to_tidy = ($Specific_output_file ne '') ? $Specific_output_file : 'a.out';
1837 &prepareWin32DllLink(1);
1839 local($to_do) = "$lnkr $Verbose @Ld_flags $output @Link_file $TopClosureFile $libdirs @UserLibrary @SysLibrary";
1840 &run_something($to_do, 'Linker');
1842 # finally, check the consistency info in the binary
1843 local($executable) = $Files_to_tidy[0];
1844 @Files_to_tidy = (); # reset; we don't want to nuke it if it's inconsistent
1847 # dynamically load consistency-chking code; then do it.
1848 require('ghc-consist.prl')
1849 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-consist.prl!\n");
1851 &chk_consistency_info ( $executable );
1854 # if PVM parallel stuff, we do truly weird things.
1855 # Essentially: (1) move the executable over to where PVM expects
1856 # to find it. (2) create a script in place of the executable
1857 # which will cause the program to be run, via SysMan.
1858 if ( $PARing eq 'p' ) {
1859 local($pvm_executable) = $executable;
1860 local($pvm_executable_base);
1862 if ( $pvm_executable !~ /^\// ) { # a relative path name: make absolute
1863 local($pwd) = `pwd`;
1865 $pwd =~ s/^\/tmp_mnt//;
1866 $pvm_executable = "$pwd/$pvm_executable";
1869 $pvm_executable =~ s|/|=|g; # make /s into =s
1870 $pvm_executable_base = $pvm_executable;
1872 $pvm_executable = $ENV{'PVM_ROOT'} . '/bin/' . $ENV{'PVM_ARCH'}
1873 . "/$pvm_executable";
1875 &run_something("$Rm -f $pvm_executable; $Cp -p $executable $pvm_executable && $Rm -f $executable", 'Moving binary to PVM land');
1877 # OK, now create the magic script for "$executable"
1878 open(EXEC, "> $executable") || &tidy_up_and_die(1,"$Pgm: couldn't open $executable to write!\n");
1879 print EXEC <<EOSCRIPT1;
1880 eval 'exec perl -S \$0 \${1+"\$@"}'
1881 if \$running_under_some_shell;
1882 # =!=!=!=!=!=!=!=!=!=!=!
1883 # This script is automatically generated: DO NOT EDIT!!!
1884 # Generated by Glasgow Haskell, version ${ProjectVersion} ${ProjectPatchLevel}
1886 \$pvm_executable = '$pvm_executable';
1887 \$pvm_executable_base = '$pvm_executable_base';
1888 \$SysMan = '$SysMan';
1891 print EXEC <<\EOSCRIPT2;
1892 # first, some magical shortcuts to run "commands" on the binary
1894 if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {
1896 system("$cmd $pvm_executable");
1900 # OK, really run it; process the args first
1901 $ENV{'PE'} = $pvm_executable_base;
1903 $nprocessors = 2; # the default
1907 # ToDo: handle --RTS
1908 args: while ($a = shift(@ARGV)) {
1909 if ( $a eq '+RTS' ) {
1911 } elsif ( $a eq '-RTS' ) {
1914 if ( $a eq '-d' && $in_RTS_args ) {
1916 } elsif ( $a =~ /^-N(\d+)/ && $in_RTS_args ) {
1919 push(@nonPVM_args, $a);
1923 local($return_val) = 0;
1924 system("$SysMan $debug $pvm_executable $nprocessors @nonPVM_args");
1926 system("mv $ENV{'HOME'}/$pvm_executable_base.???.gr .") if -f "$ENV{'HOME'}/$pvm_executable_base.001.gr";
1929 close(EXEC) || die "Failed closing $executable\n";
1930 chmod 0755, $executable;
1934 sub createWin32DLL()
1938 # append last minute flags linker and consistency flags
1943 # glue them together:
1944 push(@UserLibrary_dir, @SysLibrary_dir);
1946 $libdirs = '-L' . join(' -L',@UserLibrary_dir) if $#UserLibrary_dir >= 0;
1948 &prepareWin32DllLink(0);
1950 local ($bld_dll) = "dllwrap";
1952 local ($output) = ($Specific_output_file ne '') ? "$Specific_output_file" : 'HSdll.dll';
1953 local ($output_dir);
1954 local ($output_file);
1955 local ($output_lib, $output_def);
1957 ($output_dir = $output) =~ s|(.*/)[^/]+$|$1|;
1958 $output_dir = "" if ($output_dir eq $output);
1959 ($output_file = $output) =~ s|.*/([^/]+)$|$1|;
1961 ($output_lib = $output_file) =~ s|(.+)\.[^\.]*$|${output_dir}lib$1_imp.a|;
1962 ($output_def = $output_file) =~ s|(.+)\.[^\.]*$|${output_dir}$1.def|;
1964 push (@Dll_flags, "-mno-cygwin --target=i386-mingw32") if ($TargetPlatform =~ /^.*mingw32$/);
1965 push (@Dll_flags, "--output-lib $output_lib");
1966 # If the "--def " option hasn't been supplied, assume everything
1967 # is going to be exported via the DLL.."
1968 if (!grep(/--def/, @Dll_flags)) {
1969 push (@Dll_flags, "--export-all --output-def $output_def");
1972 local($to_do) = "$bld_dll @Dll_flags -o $output @Link_file $libdirs @UserLibrary @SysLibrary";
1973 # Make sure the user sees this piece of magic.
1974 print STDERR "$to_do\n" if (!$Verbose);
1975 &run_something($to_do, 'DLL creator');
1978 sub prepareWin32DllLink ()
1980 local($linking_main) = @_;
1983 # Win32 DLLs - link with import libraries, not the real archives.
1985 if ( $TargetPlatform =~ /-mingw32$/ ) {
1988 # If the libraries have the form libHSfoo.a, we
1989 # transform that into libHSfoo_imp.a - the import
1990 # library of the DLL.
1992 foreach $a ( @SysLibrary ) {
1993 $a = "${a}_imp" if ($a =~ /^-lHS/);
1995 foreach $a ( @UserLibrary ) {
1996 $a = "${a}_imp" if ($a =~ /^-lHS/);
1998 push(@Link_file, ( $INSTALLING ) ? "$InstLibDirGhc/Main.o"
1999 : "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR/Main.o") if $linking_main;
2000 push(@Link_file, ( $INSTALLING ) ? "$InstLibDirGhc/PrelMain.o"
2001 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/PrelMain.o") if $linking_main;
2003 push(@Ld_flags, "-mno-cygwin");
2009 %************************************************************************
2011 \section[Driver-misc-utils]{Miscellaneous utilities}
2013 %************************************************************************
2015 %************************************************************************
2017 \subsection[Driver-odir-ify]{@odir_ify@: Mangle filename if \tr{-odir} set}
2019 %************************************************************************
2023 local($ofile,$def_suffix) = @_;
2025 return(($Osuffix eq '') ? "$ofile.$def_suffix" : "$ofile.$Osuffix" );
2029 local($orig_file, $def_suffix) = @_;
2030 if ($Specific_output_dir eq '') { # do nothing
2031 &osuf_ify($orig_file, $def_suffix);
2033 local ($orig_file_only);
2034 ($orig_file_only = $orig_file) =~ s|.*/||;
2035 &osuf_ify("$Specific_output_dir/$orig_file_only",$def_suffix);
2042 local($is_hc_file, $hsc_out, $cc_as_o) = @_;
2044 local($includes) = '-I' . join(' -I', @Include_dir);
2047 local($c_flags) = "@CcBoth_flags";
2048 local($ddebug_flag) = ( $DEBUGging ) ? '-DDEBUG' : '';
2050 $c_flags .= " -mno-cygwin" if ( $TargetPlatform =~ /-mingw32$/ );
2052 # "input" files to use that are not in some weird directory;
2053 # to help C compilers grok .hc files [ToDo: de-hackify]
2054 local($cc_help) = "ghc$$.c";
2055 local($cc_help_s) = "ghc$$.s";
2058 $s_output = (($is_hc_file && $DoAsmMangling) || $TargetPlatform =~ /^(powerpc|rs6000|hppa)/) ? $cc_as_o : $cc_as;
2059 $c_flags .= " @CcRegd_flags";
2060 $c_flags .= ($is_hc_file) ? " @CcRegd_flags_hc" : " @CcRegd_flags_c";
2062 # C compiler won't like the .hc extension. So we create
2063 # a tmp .c file which #include's the needful.
2064 open(TMP, "> $cc_help") || &tidy_up_and_die(1,"$Pgm: failed to open `$cc_help' (to write)\n");
2065 if ( $is_hc_file ) {
2069 # user may have asked for #includes to be injected...
2070 print TMP @CcInjects if $#CcInjects >= 0;
2072 # Straight .c files may want to know that they're being used
2073 # with a particular version of GHC, so we define __GLASGOW_HASKELL__ for their benefit.
2074 print TMP "#define __GLASGOW_HASKELL__ ${ProjectVersionInt}\n";
2076 # heave in the consistency info
2077 print TMP "static char ghc_cc_ID[] = \"\@(#)cc $ifile\t$Cc_major_version.$Cc_minor_version,$Cc_consist_options\";\n";
2079 print TMP "#include \"$hsc_out\"\n";
2080 close(TMP) || &tidy_up_and_die(1,"Failed writing to $cc_help\n");
2082 # Don't redirect stderr into intermediate file if slamming output onto stdout (e.g., with -E)
2083 local($fuse_stderr) = "2>&1" if ! $Only_preprocess_hc;
2084 local($to_do) = "$cc $Verbose $ddebug_flag $c_flags @Cpp_define $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 )";
2086 if ( $Only_preprocess_hc ) { # HACK ALERT!
2087 $to_do =~ s/ -S\b//g;
2089 push(@Files_to_tidy, $cc_help, $cc_help_s, $s_output );
2090 $PostprocessCcOutput = 1 if ! $Only_preprocess_hc; # hack, dear hack...
2091 &run_something($to_do, 'C compiler');
2092 $PostprocessCcOutput = 0;
2093 if ( $Only_preprocess_hc ) {
2094 system("$Cat $Tmp_prefix.ccout");
2096 unlink($cc_help, $cc_help_s);
2102 local($is_hc_file, $cc_as_o, $cc_as, $ifile_root) = @_;
2104 print STDERR `cat $cc_as_o` if $Dump_raw_asm; # to stderr, before mangling
2106 if ($is_hc_file && $DoAsmMangling) {
2107 # dynamically load assembler-fiddling code, which we are about to use:
2108 require('ghc-asm.prl')
2109 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm.prl!\n");
2110 # post-process the assembler [.hc files only]
2111 &mangle_asm($cc_as_o, $cc_as);
2113 } elsif ($TargetPlatform =~ /^hppa/) {
2114 # minor mangling of non-threaded files for hp-pa only
2115 require('ghc-asm.prl')
2116 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-hppa.prl!\n");
2117 &mini_mangle_asm_hppa($cc_as_o, $cc_as);
2119 } elsif ($TargetPlatform =~ /^powerpc|^rs6000/) {
2120 # minor mangling of non-threaded files for powerpcs and rs6000s
2121 require('ghc-asm.prl')
2122 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-powerpc.prl!\n");
2123 &mini_mangle_asm_powerpc($cc_as_o, $cc_as);
2126 # save a copy of the .s file, even if we are carrying on...
2127 #if ($do_as && $Keep_s_file_too) {
2128 # &saveIntermediate($ifile_root , "s" , $cc_as);
2135 local($as_out, $ifile_root) = @_;
2137 local($asmblr) = ( $As ) ? $As : $CcRegd;
2139 # need to add the -I flags in case the file is going through cpp (.S files)
2140 local($includes) = '-I' . join(' -I', @Include_dir);
2142 if ( ! $SplitObjFiles ) {
2143 local($to_do) = "$asmblr -o $as_out -c @As_flags $includes $cc_as";
2144 push(@Files_to_tidy, $as_out );
2145 &run_something($to_do, 'Unix assembler');
2147 } else { # more complicated split-ification...
2149 # must assemble files $Tmp_prefix__[1 .. $NoOfSplitFiles].s
2151 # If -odir is used, great, just pin it in front of the
2152 # generated split file names. If it hasn't been set, we
2153 # snatch it from the ifile_root.
2157 if ( $Specific_output_dir eq '' ) {
2158 $Specific_output_dir = ${ifile_root};
2161 for ($f = 1; $f <= $NoOfSplitFiles; $f++ ) {
2162 local($split_out) = &odir_ify("${ifile_root}__${f}",'o');
2163 local($to_do) = "$asmblr -o $split_out -c @As_flags ${Tmp_prefix}__${f}.s";
2164 push(@Files_to_tidy, $split_out );
2166 &run_something($to_do, 'Unix assembler');
2172 %************************************************************************
2174 \subsection[Driver-run-something]{@run_something@: Run a phase}
2176 %************************************************************************
2180 local($str_to_do, $tidy_name) = @_;
2182 print STDERR "\n$tidy_name:\n\t" if $Verbose;
2183 print STDERR "$str_to_do\n" if $Verbose;
2185 if ($Using_dump_file) {
2186 open(DUMP, ">> $Specific_dump_file")
2187 || &tidy_up_and_die(1,"$Pgm: failed to open `$Specific_dump_file'\n");
2188 print DUMP "\nCompilation Dump for: $str_to_do\n\n";
2190 || &tidy_up_and_die(1,"$Pgm: failed closing `$Specific_dump_file'\n");
2193 local($return_val) = 0;
2195 if ( length($str_to_do) > 4000) {
2196 # 4000 - on the random side, just like the *real* ARG_MAX
2199 # With some shells, command lines of this length may
2200 # very well cause trouble. To safeguard against this, we squirrel the
2201 # command into a file and exec that.
2202 local ($sh) = $ENV{'REAL_SHELL'};
2203 print STDERR "Backup plan A: saving cmd line in ${Tmp_prefix}.sh and executing that with $sh\n" if $Verbose;
2204 open (TEMP, "> ${Tmp_prefix}.sh") ||
2205 &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.sh'\n");
2206 print TEMP "$Time $str_to_do\n";
2208 &tidy_up_and_die(1,"$Pgm: failed closing `$Tmp_prefix.sh'\n");
2209 system("$sh $Tmp_prefix.sh");
2212 unlink "${Tmp_prefix}.sh";
2214 system("$Time $str_to_do");
2218 if ( $PostprocessCcOutput ) { # hack, continued
2219 open(CCOUT, "< $Tmp_prefix.ccout")
2220 || &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.ccout'\n");
2222 next if /call-clobbered/;
2223 next if /control reaches end/;
2224 next if /from .*Stg\.h:/;
2225 next if /from ghc\d+.c:\d+:/;
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";
2238 &tidy_up_and_die($return_val, '');
2240 $Using_dump_file = 0;
2244 %************************************************************************
2246 \subsection[Driver-ghc-timing]{Emit nofibbish GHC timings}
2248 %************************************************************************
2250 NB: nearly the same as in @runstdtest@ script.
2253 sub process_ghc_timings {
2254 local($StatsFile) = "$Tmp_prefix.stat";
2255 local($SysSpecificTiming) = 'ghc';
2257 open(STATS, $StatsFile) || die "Failed when opening $StatsFile\n";
2258 local($max_live) = 0;
2259 local($tot_live) = 0; # for calculating residency stuff
2260 local($tot_samples) = 0;
2263 if (! /Gen:\s+0/ && ! /Minor/ && /^\s*\d+\s+\d+\s+(\d+)\s+\d+\.\d+/ ) {
2264 $max_live = $1 if $max_live < $1;
2268 $BytesAlloc = $1 if /^\s*([0-9,]+) bytes allocated in the heap/;
2270 if ( /^\s*([0-9,]+) bytes maximum residency .* (\d+) sample/ ) {
2271 $MaxResidency = $1; $ResidencySamples = $2;
2274 $GCs = $1 if /^\s*([0-9,]+) (collections? in generation 0|garbage collections? performed)/;
2276 if ( /^\s+([0-9]+)\s+Mb total memory/ ) {
2280 # The presence of -? in the following pattern is only there to
2281 # accommodate 0.29 && <= 2.05 RTS'
2282 if ( /^\s*INIT\s+time\s*(\d+\.\d\d)s\s*\(\s*-?(\d+\.\d\d)s elapsed\)/ ) {
2283 $InitTime = $1; $InitElapsed = $2;
2284 } elsif ( /^\s*MUT\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2285 $MutTime = $1; $MutElapsed = $2;
2286 } elsif ( /^\s*GC\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2287 $GcTime = $1; $GcElapsed = $2;
2290 close(STATS) || die "Failed when closing $StatsFile\n";
2291 if ( $tot_samples > 0 ) {
2292 $ResidencySamples = $tot_samples;
2293 $MaxResidency = $max_live;
2294 $AvgResidency = int ($tot_live / $tot_samples) ;
2297 # warn about what we didn't find
2298 print STDERR "Warning: BytesAlloc not found in stats file\n" unless defined($BytesAlloc);
2299 print STDERR "Warning: GCs not found in stats file\n" unless defined($GCs);
2300 print STDERR "Warning: InitTime not found in stats file\n" unless defined($InitTime);
2301 print STDERR "Warning: InitElapsed not found in stats file\n" unless defined($InitElapsed);
2302 print STDERR "Warning: MutTime not found in stats file\n" unless defined($MutTime);
2303 print STDERR "Warning: MutElapsed not found in stats file\n" unless defined($MutElapsed);
2304 print STDERR "Warning: GcTime inot found in stats file\n" unless defined($GcTime);
2305 print STDERR "Warning: GcElapsed not found in stats file\n" unless defined($GcElapsed);
2307 # things we didn't necessarily expect to find
2308 $MaxResidency = 0 unless defined($MaxResidency);
2309 $AvgResidency = 0 unless defined($AvgResidency);
2310 $ResidencySamples = 0 unless defined($ResidencySamples);
2313 $BytesAlloc =~ s/,//g;
2314 $MaxResidency =~ s/,//g;
2316 $InitTime =~ s/,//g;
2317 $InitElapsed =~ s/,//g;
2319 $MutElapsed =~ s/,//g;
2321 $GcElapsed =~ s/,//g;
2323 # print out what we found
2324 print STDERR "<<$SysSpecificTiming: ",
2325 "$BytesAlloc bytes, $GCs GCs, $AvgResidency/$MaxResidency avg/max bytes residency ($ResidencySamples samples), ${TotMem}M in use, $InitTime INIT ($InitElapsed elapsed), $MutTime MUT ($MutElapsed elapsed), $GcTime GC ($GcElapsed elapsed)",
2326 " :$SysSpecificTiming>>\n";
2333 %************************************************************************
2335 \subsection[Driver-dying]{@tidy_up@ and @tidy_up_and_die@: Dying gracefully}
2337 %************************************************************************
2341 local($to_do) = "\n$Rm $Tmp_prefix*";
2342 if ( $Tmp_prefix !~ /^\s*$/ ) {
2343 print STDERR "$to_do\n" if $Verbose;
2348 sub tidy_up_and_die {
2349 local($return_val, $msg) = @_;
2351 # delete any files to tidy
2352 print STDERR "deleting... @Files_to_tidy\n" if $Verbose && $#Files_to_tidy >= 0;
2353 unlink @Files_to_tidy if $#Files_to_tidy >= 0;
2357 exit (($return_val == 0) ? 0 : 1);
2361 %************************************************************************
2363 \subsection[Driver-arg-with-arg]{@grab_arg_arg@: Do an argument with an argument}
2365 %************************************************************************
2367 Some command-line arguments take an argument, e.g.,
2368 \tr{-Rmax-heapsize} expects a number to follow. This can either be
2369 given a part of the same argument (\tr{-Rmax-heapsize8M}) or as the
2370 next argument (\tr{-Rmax-heapsize 8M}). We allow both cases.
2372 Note: no error-checking; \tr{-Rmax-heapsize -Rgc-stats} will silently
2373 gobble the second argument (and probably set the heapsize to something
2377 local(*Args, $option, $rest_of_arg) = @_;
2379 if ($rest_of_arg ne '') {
2380 return($rest_of_arg);
2381 } elsif ($#Args >= 0) {
2382 local($temp) = $Args[0]; shift(@Args);
2385 print STDERR "$Pgm: no argument following $option option\n";
2396 #Not in HsC_antiflag ## NO!: and not already in HsC_flags
2398 foreach $f ( @HsC_antiflags ) {
2399 return(0) if $flag eq $f;
2401 # foreach $f ( @HsC_flags ) {
2402 # return(0) if $flag eq $f;
2407 sub squashHscFlag { # pretty terrible
2411 foreach $f ( @HsC_flags ) {
2412 if ($flag eq $f) { $f = ''; }
2420 foreach $f ( @flags ) {
2421 push( @HsC_flags, $f ) if &isntAntiFlag($f);
2426 To add another system library, you'll need to augment the
2427 Supported_syslibs variable with name and info on your addition
2428 to the syslib family. The info bit consist of the following:
2430 - interface file directory
2431 see the misc or posix entry for how to distinguish
2432 between using installed and build tree directories.
2434 - directory location of archives
2436 - location of (way-independent) C support libs.
2437 not all libraries need this - if you don't, just
2438 give the empty string.
2439 - list of syslibs you depend on.
2441 - additional ghc command line flags that should be used.
2442 - additional C compiler command line flags that should be used.
2448 # Hash to keep track of
2449 %Syslibs_added = ();
2452 local($syslib) = @_;
2454 # Lifting this out of this sub brings it out of scope - why??
2455 %Supported_syslibs =
2457 [ # where to slurp interface files from
2459 ? "$InstLibDirGhc/imports/exts"
2460 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/exts"
2462 , # where to find the archive to use when linking
2465 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/exts"
2468 , '' # Syslib dependencies
2469 , '' # extra ghc opts
2470 , '' # extra cc opts
2471 , '' # extra ld opts
2475 [ # where to slurp interface files from
2477 ? "$InstLibDirGhc/imports/misc"
2478 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/misc"
2480 , # where to find the archive to use when linking
2483 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/misc"
2485 , # where to find the cbits archive to use when linking
2488 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/misc/cbits"
2490 , 'exts' # Syslib dependencies
2491 , '' # extra ghc opts
2492 , '' # extra cc opts
2493 , ( $TargetPlatform =~ /-solaris2$/ ? '-lnsl -lsocket' : '')
2496 [ # where to slurp interface files from
2498 ? "$InstLibDirGhc/imports/hbc"
2499 : "$TopPwd/CONTRIB/libraries/hbc/src"
2501 , # where to find the archive to use when linking
2504 : "$TopPwd/CONTRIB/libraries/src/hbc"
2506 , # where to find the cbits archive to use when linking
2509 : "$TopPwd/CONTRIB/libraries/hbc/cbits"
2511 , 'exts' # Syslib dependencies
2512 , '' # extra ghc opts
2513 , '' # extra cc opts
2517 [ # where to slurp interface files from
2519 ? "$InstLibDirGhc/imports/posix"
2520 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/posix"
2522 , # where to find the archive to use when linking
2525 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/posix"
2527 , # where to find the cbits archive to use when linking
2530 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/posix/cbits"
2532 , 'misc' # Syslib dependencies
2533 , '' # extra ghc opts
2534 , '' # extra cc opts
2535 , '' # extra ld opts
2538 [ # where to slurp interface files from
2540 ? "$InstLibDirGhc/imports/concurrent"
2541 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/concurrent"
2543 , # where to find the archive to use when linking
2546 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/concurrent"
2548 , '' # where to find the cbits archive to use when linking
2549 , '' # Syslib dependencies
2550 , '' # extra ghc opts
2551 , '' # extra cc opts
2552 , '' # extra ld opts
2555 [ # where to slurp interface files from
2557 ? "$InstLibDirGhc/imports/win32"
2558 : "$TopPwd/hslibs/win32/src"
2560 , # where to find the archive to use when linking
2563 : "$TopPwd/hslibs/win32/src"
2566 , 'exts' # Syslib dependencies
2567 , '' # extra ghc opts
2568 , '' # extra cc opts
2569 , '-luser32 -lgdi32' # extra ld opts
2572 [ # where to slurp interface files from
2574 ? "$InstLibDirGhc/imports/com"
2575 : "$TopPwd/hdirect/lib"
2577 , # where to find the archive to use when linking
2580 : "$TopPwd/hdirect/lib"
2583 , 'exts' # Syslib dependencies
2584 , '' # extra ghc opts
2585 , '' # extra cc opts
2586 , '-luser32 -lole32 -loleaut32 -ladvapi32'
2591 # check if it's supported..
2593 if ( !exists $Supported_syslibs{$syslib} ) {
2594 print STDERR "$Pgm: no such system library (-syslib): $syslib\n";
2599 # This check is here to avoid syslib loops from
2600 # spoiling the party. A side-effect of it is that
2601 # it disallows multiple mentions of a syslib on a command-line,
2602 # explicit *and* implicit ones (i.e., "-syslib exts -syslib misc"
2603 # is not equal to "-syslib exts -syslib misc -syslib exts",
2604 # which it needs to be)
2606 # Since our current collection of syslibs don't have any
2607 # loops, this test is disabled.
2609 # ToDo: loop avoidance scheme when the need arises
2611 #return if ( exists $Syslibs_added{$syslib} );
2613 $Syslibs_added{$syslib} = 1;
2615 local ($hi_dir, $lib_dir, $lib_cbits_dir,
2616 $syslib_deps, $syslib_ghc_opts,
2617 $syslib_cc_opts, $syslib_ld_opts) = @{ $Supported_syslibs{$syslib} };
2620 unshift(@SysImport_dir, $hi_dir);
2621 push(@SysLibrary_dir, $lib_dir);
2622 push(@SysLibrary_dir, $lib_cbits_dir) if ( $lib_cbits_dir ne '');
2624 push(@SysLibrary, "-lHS$syslib");
2625 push(@SysLibrary, "-lHS${syslib}_cbits") if ( $lib_cbits_dir ne '');
2626 push(@SysLibrary, $syslib_ld_opts) if ($syslib_ld_opts ne '');
2628 # Add on any extra dependencies.
2629 foreach $lib (split(' ',$syslib_deps)) {
2635 Source files may have {-# OPTIONS ... #-} pragmas at the top, containing
2636 command line options we want to append to collection of commands specified
2637 directly. @check_for_source_options@ looks at the top of a de-lit'ified Haskell
2638 file for any such pragmas:
2641 sub check_for_source_options {
2642 local($file,$ifile) = @_;
2643 local($comment_start,$comment_end);
2645 if ($ifile =~ /\.hc$/ ||
2648 $ifile =~ /_s$/ ) { # `Real' C intermediate
2649 $comment_start = "/\\*";
2650 $comment_end = "\\*/";
2651 } else { # Assume it is a file containing Haskell source
2652 $comment_start = "{-#";
2653 $comment_end = "#-}";
2656 open(FILE,$file) || return(1); # No big loss
2659 if ( /^${comment_start} OPTIONS (.*)${comment_end}$/ ) {
2660 # add the options found at the back of the command line.
2661 local(@entries) = split(/\s+/,$1);
2662 print STDERR "Found OPTIONS " . join(' ',@entries) . " in $file\n" if $Verbose;
2663 push(@File_options, @entries);
2665 elsif ( /^$/ ) { # ignore empty lines
2668 elsif ( /^#line.+$/ ) { # ignore comment lines (unused..ToDo: rm )
2671 elsif ( /^{-# LINE.+$/ ) { # ignore line pragmas
2674 else { # stop looking, something non-empty / not
2675 # ${comment_start} OPTIONS .. ${comment_end} encountered.
2676 close(FILE);return(0);
2685 We split the initial argv up into three arrays:
2691 the reason for doing so is to be able to deal
2692 with {-# OPTIONS #-} pragma in source files properly.
2698 arg: while($_ = $args[0]) {
2700 # sigh, we have to deal with these -option arg specially here.
2701 /^-(tmpdir|odir|ohi|o|isuf|osuf|hisuf|odump|syslib)$/ &&
2702 do { push(@Cmd_opts, $_); push(@Cmd_opts,$args[0]); shift(@args); next arg; };
2703 /^--?./ && do { push(@Cmd_opts, $_); next arg; };
2705 if (/\.([^_]+_)?[oa]$/) {
2706 push(@Link_file, $_);
2708 push(@Input_file, $_);
2711 # input files must exist:
2713 print STDERR "$Pgm: input file doesn't exist: $_\n";
2721 When saving an intermediate file (.hc or .s) away, we
2722 have to prefix any OPTIONS found in the original source file.
2725 sub saveIntermediate {
2726 local ($final,$suffix,$tmp)= @_ ;
2729 # $final -- root of where to park ${final}.${suffix}
2730 # $tmp -- temporary file where hsc put the intermediate file.
2732 # Delete the old file
2733 $to_do = "$Rm ${final}.${suffix}"; &run_something($to_do, "Removing old .${suffix} file");
2735 if ( $#File_options >= 0 ) { # OPTIONS found in Haskell source unit
2736 # Add OPTION comment to the top of the generated .${suffix} file
2737 open(TEMP, "> ${final}.${suffix}") || &tidy_up_and_die(1,"Can't open ${final}.${suffix}\n");
2738 print TEMP "/* OPTIONS " . join(' ',@File_options) . " */\n";
2740 print STDERR "Prepending OPTIONS: " . join(' ',@File_options) . " to ${final}.${suffix}\n" if $Verbose;
2742 $to_do = "$Cat $tmp >> ${final}.${suffix}";
2743 &run_something($to_do, "Saving copy of .${suffix} file");
2750 Command-line processor
2756 # can't use getopt(s); what we want is too complicated
2758 arg: while($_ = $Args[0]) {
2761 #---------- help -------------------------------------------------------
2762 if (/^-\?$/ || /^--?help$/) { print $LongUsage; exit $Status; }
2764 #-----------version ----------------------------------------------------
2765 /^--version$/ && do { print STDERR "${ProjectName}, version ${ProjectVersion}, patchlevel ${ProjectPatchLevel}\n"; exit $Status; };
2767 #---------- verbosity and such -----------------------------------------
2768 /^-v$/ && do { $Verbose = '-v'; $Time = 'time'; next arg; };
2770 #---------- what phases are to be run ----------------------------------
2771 /^-(no-)?recomp/ && do { $Do_recomp_chkr = ($1 eq '') ? 1 : 0; next arg; };
2773 /^-cpp$/ && do { $Cpp_flag_set = 1; next arg; };
2774 # change the global default:
2775 # we won't run cat; we'll run the real thing
2777 /^-C$/ && do { $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0; $HscOut = '-C=';
2779 # stop after generating C
2781 /^-noC$/ && do { $HscOut = '-N='; $ProduceHi = '-nohifile=';
2782 $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0;
2784 # leave out actual C generation (debugging) [also turns off interface gen]
2787 /^-hi$/ && do { $HiOnStdout = 1; $ProduceHi = '-hifile='; next arg; };
2788 # _do_ generate an interface; usually used as: -noC -hi
2789 /^-hi-with-(.*)$/ && do { $HiOnStdout = 1; $HiWith .= " $1" ; $ProduceHi = '-hifile='; next arg; };
2790 # limit ourselves to outputting a particular section.
2792 /^-nohi$/ && do { $ProduceHi = '-nohifile='; next arg; };
2793 # don't generate an interface (even if generating C)
2795 /^-hi-diffs$/ && do { $HiDiff_flag = 'normal'; next arg; };
2796 /^-hi-diffs-with-usages$/ && do { $HiDiff_flag = 'usages'; next arg; };
2797 /^-no-hi-diffs$/ && do { $HiDiff_flag = ''; next arg; };
2798 /^-keep-hi-diffs$/ && do { $Keep_HiDiffs = 1; next arg; };
2800 # show/disable diffs if the interface file changes
2802 /^-E$/ && do { push(@CcBoth_flags, '-E');
2803 $Only_preprocess_C = 1;
2804 $Do_as = 0; $Do_lnkr = 0; next arg; };
2805 # stop after preprocessing C
2806 /^-M$/ && do { $Only_generate_deps = 1; $Do_as = 0; $Do_lnkr = 0; next arg; };
2807 # only generate dependency information.
2808 /^--mk-dll$/ && do { $Only_generate_dll = 1; $Do_as = 0; $Do_lnkr = 0; next arg; };
2809 # Build a Win32 DLL (where supported).
2810 /^-S$/ && do { $Do_as = 0; $Do_lnkr = 0; next arg; };
2811 # stop after generating assembler
2813 /^-c$/ && do { $Do_lnkr = 0; next arg; };
2814 # stop after generating .o files
2816 /^-link-chk$/ && do { $LinkChk = 1; next arg; };
2817 # don't do consistency-checking after a link
2818 /^-no-link-chk$/ && do { $LinkChk = 0; next arg; };
2820 /^-tmpdir$/ && do { $Tmp_prefix = &grab_arg_arg(*Args,'-tmpdir', '');
2821 $Tmp_prefix = "$Tmp_prefix/ghc$$";
2822 $ENV{'TMPDIR'} = $Tmp_prefix; # for those who use it...
2824 # use an alternate directory for temp files
2826 #---------- redirect output --------------------------------------------
2828 # -o <file>; applies to the last phase, whatever it is
2829 # "-o -" sends it to stdout
2830 # if <file> has a directory component, that dir must already exist
2832 /^-odir$/ && do { $Specific_output_dir = &grab_arg_arg(*Args,'-odir', '');
2834 # Hack, of the worst sort: don't do validation of
2835 # odir argument if you're using -M (dependency generation).
2837 if ( ! $Only_generate_deps && ! -d $Specific_output_dir) {
2838 print STDERR "$Pgm: -odir: no such directory: $Specific_output_dir\n";
2843 /^-o$/ && do { $Specific_output_file = &grab_arg_arg(*Args,'-o', '');
2844 if ($Specific_output_file ne '-'
2845 && $Specific_output_file =~ /(.*)\/[^\/]*$/) {
2846 local($dir_part) = $1;
2847 if (! -d $dir_part) {
2848 print STDERR "$Pgm: no such directory: $dir_part\n";
2854 # NB: -isuf not documented yet (because it doesn't work yet)
2855 /^-isuf$/ && do { $Isuffix = &grab_arg_arg(*Args,'-isuf', '');
2856 if ($Isuffix =~ /\./ ) {
2857 print STDERR "$Pgm: -isuf suffix shouldn't contain a .\n";
2862 /^-osuf$/ && do { $Osuffix = &grab_arg_arg(*Args,'-osuf', '');
2863 if ($Osuffix =~ /\./ ) {
2864 print STDERR "$Pgm: -osuf suffix shouldn't contain a .\n";
2869 # -ohi <file>; send the interface to <file>; "-ohi -" to send to stdout
2870 /^-ohi$/ && do { $Specific_hi_file = &grab_arg_arg(*Args,'-ohi', '');
2871 if ($Specific_hi_file ne '-'
2872 && $Specific_hi_file =~ /(.*)\/[^\/]*$/) {
2873 local($dir_part) = $1;
2874 if (! -d $dir_part) {
2875 print STDERR "$Pgm: no such directory: $dir_part\n";
2879 $ProduceHi='-hifile=';
2882 # The suffix to use when looking for interface files
2883 /^-hisuf$/ && do { $HiSuffix = &grab_arg_arg(*Args,'-hisuf', '');
2884 if ($HiSuffix =~ /\./ ) {
2885 print STDERR "$Pgm: -hisuf suffix shouldn't contain a .\n";
2889 /^-odump$/ && do { $Specific_dump_file = &grab_arg_arg(*Args,'-odump', '');
2890 if ($Specific_dump_file =~ /(.*)\/[^\/]*$/) {
2891 local($dir_part) = $1;
2892 if (! -d $dir_part) {
2893 print STDERR "$Pgm: no such directory: $dir_part\n";
2899 #-------------- scc & Profiling Stuff ----------------------------------
2901 /^-prof$/ && do { $PROFing = 'p'; next arg; }; # profiling -- details later!
2903 /^-auto-dicts$/ && do {
2904 $PROFdicts = '-fauto-sccs-on-dicts';
2906 /^-auto-all$/ && do {
2907 $PROFauto = '-fauto-sccs-on-all-toplevs';
2910 $PROFauto = '-fauto-sccs-on-exported-toplevs';
2913 /^-caf-all/ && do { # generate individual CAF SCC annotations
2914 $PROFcaf = '-fauto-sccs-on-individual-cafs';
2917 /^-ignore-scc$/ && do {
2918 # forces ignore of scc annotations even if profiling
2919 $PROFignore_scc = '-W';
2922 /^-G(.*)$/ && do { push(@HsC_flags, "-G=$1"); # set group for cost centres
2925 /^-unprof-scc-auto/ && do {
2926 # generate auto SCCs on top level bindings when not profiling.
2927 # Used to measure optimisation effects of presence of sccs.
2928 $UNPROFscc_auto = ( /-all/ )
2929 ? '-fauto-sccs-on-all-toplevs'
2930 : '-fauto-sccs-on-exported-toplevs';
2933 #--------- ticky/parallel ----------------------------------------------
2934 # we sort out the details a bit later on
2936 /^-gransim$/ && do { $GRANing = 'g'; &add_syslib('concurrent'); next arg; }; # GranSim
2937 /^-ticky$/ && do { $TICKYing = 't'; next arg; }; # ticky-ticky
2938 /^-parallel$/ && do { $PARing = 'p'; &add_syslib('concurrent'); next arg; }; # parallel Haskell
2940 #-------------- "user ways" --------------------------------------------
2942 (/^-user-setup-([a-oA-Z])$/ ) &&
2944 /^-user-setup-([a-oA-Z])$/ && do { $BuildTag = "_$1"; };
2946 local($stuff) = $UserSetupOpts{$BuildTag};
2947 local(@opts) = split(/\s+/, $stuff);
2949 # feed relevant ops into the arg-processing loop (if any)
2950 unshift(@Args, @opts) if $#opts >= 0;
2954 #---------- set search paths for libraries and things ------------------
2956 # we do -i just like HBC (-i clears the list; -i<colon-separated-items>
2957 # prepends the items to the list); -I is for including C .h files.
2959 /^-i$/ && do { @Import_dir = (); # import path cleared!
2960 @SysImport_dir = ();
2961 print STDERR "WARNING: import paths cleared by `-i'\n";
2964 /^-i(.*)/ && do { local(@new_items)
2965 = split( /:/, &grab_arg_arg(*Args,'-i', $1));
2966 unshift(@Import_dir, @new_items);
2969 /^-I(.*)/ && do { push(@Include_dir, &grab_arg_arg(*Args,'-I', $1)); next arg; };
2970 /^-L(.*)/ && do { push(@UserLibrary_dir, &grab_arg_arg(*Args,'-L', $1)); next arg; };
2971 /^-l(.*)/ && do { push(@UserLibrary,'-l'.&grab_arg_arg(*Args,'-l', $1)); next arg; };
2973 /^-syslib(.*)/ && do { local($syslib) = &grab_arg_arg(*Args,'-syslib',$1);
2974 &add_syslib($syslib);
2977 #=======================================================================
2978 # various flags that we can harmlessly send to one program or another
2979 # (we will later "reclaim" some of the compiler ones now sent to gcc)
2980 #=======================================================================
2982 #---------- this driver itself (ghc) -----------------------------------
2983 # these change what executable is run for each phase:
2984 /^-pgmL(.*)$/ && do { $Unlit = $1; next arg; };
2985 /^-pgmP(.*)$/ && do { $HsCpp = $1; next arg; };
2986 /^-pgmC(.*)$/ && do { $HsC = $1; next arg; };
2987 /^-pgmcO?(.*)$/ && do { $CcRegd = $1; next arg; }; # the O? for back compat
2988 /^-pgma(.*)$/ && do { $As = $1; next arg; };
2989 /^-pgml(.*)$/ && do { $Lnkr = $1; next arg; };
2990 /^-pgmdep(.*)$/ && do { $MkDependHS = $1; next arg; };
2992 #---------- the get-anything-through opts (all pgms) -------------------
2993 # these allow arbitrary option-strings to go to any phase:
2994 /^-optL(.*)$/ && do { push(@Unlit_flags, $1); next arg; };
2995 /^-optP(.*)$/ && do { push(@HsCpp_flags, $1); next arg; };
2996 /^-optCrts(.*)$/&& do { push(@HsC_rts_flags, $1); next arg; };
2997 /^-optC(.*)$/ && do { push(@HsC_flags, $1); next arg; };
2998 /^-optcpp(.*)$/ && do { push(@Cpp_define, $1); $Only_preprocess_hc = ($1 eq "-E"); next arg; };
2999 /^-optc(.*)$/ && do { push(@CcBoth_flags, $1); next arg; };
3000 /^-opta(.*)$/ && do { push(@As_flags, $1); next arg; };
3001 /^-optl(.*)$/ && do { push(@Ld_flags, $1); next arg; };
3002 /^-optdll(.*)$/ && do { push(@Dll_flags, $1); next arg; };
3003 /^-optdep(.*)$/ && do { push(@MkDependHS_flags, $1); next arg; };
3005 #---------- Haskell C pre-processor (hscpp) ----------------------------
3006 /^-D(.*)/ && do { push(@HsCpp_flags, "'-D".&grab_arg_arg(*Args,'-D',$1)."'"); next arg; };
3007 /^-U(.*)/ && do { push(@HsCpp_flags, "'-U".&grab_arg_arg(*Args,'-U',$1)."'"); next arg; };
3009 #---------- post-Haskell "assembler"------------------------------------
3010 /^-ddump-raw-asm$/ && do { $Dump_raw_asm = 1; next arg; };
3011 /^-ddump-asm-splitting-info$/ && do { $Dump_asm_splitting_info = 1; next arg; };
3013 #---------- Haskell compiler (hsc) -------------------------------------
3015 /^-keep-hc-files?-too$/ && do { $Keep_hc_file_too = 1; next arg; };
3016 /^-keep-s-files?-too$/ && do { $Keep_s_file_too = 1; next arg; };
3018 /^-fignore-interface-pragmas$/ && do { push(@HsC_flags, $_); next arg; };
3019 /^-fignore-asserts$/ && do { push(@HsC_flags, $_); next arg; };
3021 /^-fno-implicit-prelude$/ && do { $NoImplicitPrelude= 1; push(@HsC_flags, $_); next arg; };
3024 # have the compiler proper generate concurrent code,
3025 # really only used when you want to configure your own
3026 # special user compilation way.
3028 # (ditto for -fgransim, fscc-profiling, -fparallel and -fticky-ticky)
3030 /^-fscc-profiling$/ && do { push(@HsC_flags,$_); next arg; };
3031 /^-fticky-ticky$/ && do { push(@HsC_flags,$_); next arg; };
3032 /^-fgransim$/ && do { push(@HsC_flags,$_); next arg; };
3033 /^-fparallel$/ && do { push(@HsC_flags,$_); next arg; };
3035 /^-split-objs$/ && do {
3036 if ( $TargetPlatform !~ /^(alpha|hppa1\.1|i386|m68k|mips|powerpc|rs6000|sparc)-/ ) {
3038 print STDERR "WARNING: don't know how to split objects on this platform: $TargetPlatform\n`-split-objs' option ignored\n";
3043 push(@HsC_flags, "-fglobalise-toplev-names");
3044 push(@CcBoth_flags, '-DUSE_SPLIT_MARKERS');
3046 require('ghc-split.prl')
3047 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-split.prl!\n");
3051 /^-unreg$/ && do { $UNREGing = 'u'; next arg; };
3052 /^-funregisterised$/ && do { push(@HsC_flags, $_); next arg; };
3053 /^-fno-asm-mangling$/ && do { $DoAsmMangling = 0; next arg; };
3055 /^-fallow-overlapping-instances$/ && do { push(@HsC_flags, $_); next arg; };
3056 /^-fallow-undecidable-instances$/ && do { push(@HsC_flags, $_); next arg; };
3057 /^-fhistory-size.*$/ && do { push(@HsC_flags, $_); next arg; };
3058 /^-fdicts-strict$/ && do { push(@HsC_flags, $_); next arg; };
3060 && do { push(@HsC_flags, $_);
3062 # -fglasgow-exts implies -syslib exts
3063 &add_syslib('exts');
3068 && do { $Oopt_DoSpecialise = '-fspecialise'; next arg; };
3069 /^-fno-speciali[sz]e$/
3070 && do { $Oopt_DoSpecialise = ''; next arg; };
3073 && do { $Oopt_UsageSPInf = '-fusagesp';
3074 push (@HsC_flags, '-fusagesp-on'); next arg; };
3076 /^-fcompiling-prelude$/ && do { $CompilingPrelude=1; push(@HsC_flags, $_); next arg; };
3078 # Now the foldr/build options, which are *on* by default (for -O).
3081 && do { $Oopt_FoldrBuild = 1;
3085 /^-fno-foldr-build$/
3086 && do { $Oopt_FoldrBuild = 0;
3089 # --------------- Renamer -------------
3092 /^-fno-prune-tydecls$/ && do { push(@HsC_flags, $_); next arg; };
3093 /^-fno-prune-instdecls$/ && do { push(@HsC_flags, $_); next arg; };
3097 /^-fasm-(.*)$/ && do { $HscOut = '-S='; next arg; }; # force using nativeGen
3098 /^-fvia-[cC]$/ && do { $HscOut = '-C='; next arg; }; # force using C compiler
3103 && do { push(@HsC_flags, $_); next arg };
3105 /^-funfold-casms-in-hi-file$/
3106 && do { push(@HsC_flags, $_); next arg };
3108 /^(-fmax-simplifier-iterations)(.*)$/
3109 && do { $Oopt_MaxSimplifierIterations = $1 . &grab_arg_arg(*Args,$1, $2);
3112 /^-fno-pedantic-bottoms$/
3113 && do { $Oopt_PedanticBottoms = ''; next arg; };
3115 /^-fno-pre-inlining$/
3116 && do { push(@HsC_flags, $_); next arg };
3118 /^-fno-let-from-(case|app|strict-let)$/ # experimental, really (WDP 95/10)
3119 && do { push(@HsC_flags, $_); next arg; };
3121 /^-funbox-strict-fields$/
3122 && do { push(@HsC_flags, $_); next arg; };
3124 # --------------- Warnings etc. ------
3126 /^-fwarn-(.*)$/ && do { push(@HsC_flags, $_); next arg; };
3128 /^-fno-(.*)$/ && do { push(@HsC_antiflags, "-f$1");
3129 &squashHscFlag("-f$1");
3132 /^-W$/ && do { push(@HsC_flags, @MinusWOpts); next arg; };
3133 /^-Wall$/ && do { push(@HsC_flags, @MinusWallOpts); next arg; };
3134 /^(-Wnot|w)$/ && do { foreach (@Hsc_flags) {
3135 /^-fwarn-(.*)$/ && do { $_=''; };
3137 push(@HsC_antiflags, @StandardWarnings);
3140 # --------------- fun stuff ----------------
3142 /^-freport-compile$/ && do { push(@HsC_flags, $_); next arg; };
3144 # --------------- platform specific flags (for gcc mostly) ----------------
3146 /^-mlong-calls$/ && do { # for GCC for HP-PA boxes,
3147 # for 2.6.x..?, does not apply for 2.7.2
3149 unshift(@CcBoth_flags, ( $_ ));
3152 /^-m(v8|sparclite|cypress|supersparc|cpu=(cypress|supersparc))$/
3153 && do { # for GCC for SPARCs
3154 unshift(@CcBoth_flags, ( $_ ));
3157 /^-monly-([432])-regs/ && do { # for iX86 boxes only; no effect otherwise
3158 $StolenX86Regs = $1;
3161 #*************** ... and lots of debugging ones (form: -d* )
3163 # -d(no-)core-lint is done this way so it is turn-off-able.
3164 /^-dcore-lint/ && do { $CoreLint = '-dcore-lint'; next arg; };
3165 /^-dno-core-lint/ && do { $CoreLint = ''; next arg; };
3166 # Ditto for USP lint
3167 /^-dusagesp-lint/ && do { $USPLint = '-dusagesp-lint'; next arg; };
3168 /^-dno-usagesp-lint/ && do { $USPLint = ''; next arg; };
3169 # Ditto for STG lint
3170 /^-dstg-lint/ && do { $StgLint = '-dstg-lint'; next arg; };
3171 /^-dno-stg-lint/ && do { $StgLint = ''; next arg; };
3173 /^-d(dump|ppr)-/ && do { push(@HsC_flags, $_); next arg; };
3174 /^-dverbose-(simpl|stg)/ && do { push(@HsC_flags, $_); next arg; };
3175 /^-dshow-passes/ && do { push(@HsC_flags, $_); next arg; };
3176 /^-dshow-rn-stats/ && do { push(@HsC_flags, $_); next arg; };
3177 /^-dshow-rn-trace/ && do { push(@HsC_flags, $_); next arg; };
3178 /^-dsource-stats/ && do { push(@HsC_flags, $_); next arg; };
3179 /^-dsimplifier-stats/ && do { push(@HsC_flags, $_); next arg; };
3180 /^-dstg-stats/ && do { $Oopt_StgStats = $_; next arg; };
3182 #*************** ... and now all these -R* ones for its runtime system...
3184 /^-Rscale-sizes?(.*)/ && do {
3185 $Scale_sizes_by = &grab_arg_arg(*Args,'-Rscale-sizes', $1);
3188 /^(-H|-Rmax-heapsize)(.*)/ && do {
3189 local($heap_size) = &grab_arg_arg(*Args,$1, $2);
3190 if ($heap_size =~ /(\d+)[Kk]$/) {
3191 $heap_size = $1 * 1000;
3192 } elsif ($heap_size =~ /(\d+)[Mm]$/) {
3193 $heap_size = $1 * 1000 * 1000;
3194 } elsif ($heap_size =~ /(\d+)[Gg]$/) {
3195 $heap_size = $1 * 1000 * 1000 * 1000;
3197 if ($heap_size <= 0) {
3198 print STDERR "$Pgm: resetting heap-size to zero!!! $heap_size\n";
3199 $Specific_heap_size = 0;
3201 # if several heap sizes given, take the largest...
3202 } elsif ($heap_size >= $Specific_heap_size) {
3203 $Specific_heap_size = $heap_size;
3205 print STDERR "$Pgm: ignoring heap-size-setting option ($_)...not the largest seen\n";
3209 /^(-K|Rmax-(stk|stack)size)(.*)/ && do {
3211 local($stk_size) = &grab_arg_arg(*Args,'-Rmax-stksize', $3);
3212 if ($stk_size =~ /(\d+)[Kk]$/) {
3213 $stk_size = $1 * 1000;
3214 } elsif ($stk_size =~ /(\d+)[Mm]$/) {
3215 $stk_size = $1 * 1000 * 1000;
3216 } elsif ($stk_size =~ /(\d+)[Gg]$/) {
3217 $stk_size = $1 * 1000 * 1000 * 1000;
3219 if ($stk_size <= 0) {
3220 print STDERR "$Pgm: resetting stack-size to zero!!! $stk_size\n";
3221 $Specific_stk_size = 0;
3223 # if several stack sizes given, take the largest...
3224 } elsif ($stk_size >= $Specific_stk_size) {
3225 $Specific_stk_size = $stk_size;
3227 print STDERR "$Pgm: ignoring stack-size-setting option ($flag $stk_size)...not the largest seen\n";
3231 /^-Rgc-stats$/ && do { $CollectingGCstats++;
3232 # the two RTSs do this diff ways; we will try to compensate
3235 /^-Rghc-timing/ && do { $CollectGhcTimings = 1; next arg; };
3237 #---------- C high-level assembler (gcc) -------------------------------
3238 /^-(Wall|ansi|pedantic)$/ && do { push(@CcBoth_flags, $_); next arg; };
3240 # -dgcc-lint is a useful way of making GCC very fussy.
3241 # From alan@spri.levels.unisa.edu.au (Alan Modra).
3242 /^-dgcc-lint$/ && do { push(@CcBoth_flags, '-Wall -Wpointer-arith -Wbad-function-cast -Wcast-qual -Wstrict-prototypes -Wmissing-prototypes -Wmissing-declarations -Wnested-externs'); next arg; };
3243 # An alternate set, from mark@sgcs.com (Mark W. Snitily)
3244 # -Wall -Wstrict-prototypes -Wmissing-prototypes -Wcast-align -Wshadow
3246 # inject "#include <wurble>" into the compiler's C output!
3248 /^-#include(.*)/ && do {
3249 local($to_include) = &grab_arg_arg(*Args,'-#include', $1);
3250 push(@CcInjects, "#include $to_include\n");
3253 #---------- Linker (gcc, really) ---------------------------------------
3255 /^-static$/ && do { $Static=1; push(@Ld_flags, $_); next arg; };
3256 /^-no-hs-main$/ && do { $NoHaskellMain=1; next arg; };
3258 #---------- mixed cc and linker magic ----------------------------------
3259 # this optimisation stuff is finally sorted out later on...
3261 /^-O2-for-C$/ && do { $MinusO2ForC = 1; next arg; };
3263 /^-O[1-2]?$/ && do {
3264 local($opt_lev) = ( /^-O2$/ ) ? 2 : 1; # max 'em
3265 $OptLevel = ( $opt_lev > $OptLevel ) ? $opt_lev : $OptLevel;
3267 $HscOut = '-C=' if $OptLevel == 2; # force use of C compiler
3270 /^-Onot$/ && do { $OptLevel = 0; next arg; }; # # set it to <no opt>
3272 /^-Ofile(.*)/ && do {
3274 local($ofile) = &grab_arg_arg(*Args,'-Ofile', $1);
3275 @HsC_minusO3_flags = ();
3277 open(OFILE, "< $ofile") || die "Can't open $ofile!\n";
3280 s/\#.*//; # death to comments
3281 s/[ \t]+//g; # death to whitespace
3282 next if /^$/; # ditto, blank lines
3283 s/([()*{}])/\\$1/g; # protect shell metacharacters
3285 push(@CcBoth_flags, $1);
3287 push(@HsC_minusO3_flags, $_);
3293 /^-debug$/ && do { # all this does is mark a .hc/.o as "debugging"
3294 # in the consistency info
3298 #---------- linking .a file --------------------------------------------
3300 /^-Main(.*)/ && do {
3301 # specifies main or mainPrimIO to be linked
3305 #---------- catch unrecognized flags -----------------------------------
3308 print STDERR "$Pgm: unrecognised option: $_\n";
3314 } # end of processArgs