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
779 # Case-liberation for -O2. This should be after
780 # strictness analysis and the simplification which follows it.
784 # : "-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 ]" ),
786 # Final clean-up simplification:
790 $Oopt_MaxSimplifierIterations,
791 # No -finline-phase: allow all Ids to be inlined now
798 $Oopt_FinalStgProfilingMassage,
804 # SPECIAL FLAGS for -O2
806 '-fupdate-analysis', # virtually useless; relegated to -O2
813 Sort out what we're going to do about optimising. First, the @hsc@
814 flags and regular @cc@ flags to worry about:
816 if ( $OptLevel <= 0 ) {
818 # for this level, we tell the parser -fignore-interface-pragmas
819 push(@HsC_flags, '-fignore-interface-pragmas');
820 # and tell the compiler not to produce them
821 push(@HsC_flags, '-fomit-interface-pragmas');
823 &add_Hsc_flags( @HsC_minusNoO_flags );
824 push(@CcBoth_flags, ($MinusO2ForC) ? '-O2' : '-O'); # not optional!
826 } elsif ( $OptLevel == 1 || $OptLevel == 2 ) {
828 &add_Hsc_flags( @HsC_minusO_flags );
829 push(@CcBoth_flags, ($MinusO2ForC || $OptLevel == 2) ? '-O2' : '-O'); # not optional!
830 # -O? to GCC is not optional! -O2 probably isn't worth it generally,
831 # but it *is* useful in compiling the garbage collector.
833 } else { # -Ofile, then...
835 &add_Hsc_flags( @HsC_minusO3_flags );
836 push(@HsC_flags, $Oopt_FinalStgProfilingMassage) if $Oopt_FinalStgProfilingMassage;
838 push(@CcBoth_flags, ($MinusO2ForC) ? '-O2' : '-O'); # possibly to be elaborated...
841 } # setupOptimiseFlags
845 %************************************************************************
847 \subsection{Check for consistency, etc.}
849 %************************************************************************
851 Sort out @$BuildTag@, @$PROFing@, @$PARing@,
852 @$GRANing@, @$TICKYing@, @UNREGing@:
854 sub setupBuildFlags {
857 # PROFILING stuff after argv mangling:
859 # add -auto sccs even if not profiling !
860 push(@HsC_flags, $UNPROFscc_auto) if $UNPROFscc_auto;
863 push(@HsC_flags, $PROFauto) if $PROFauto;
864 push(@HsC_flags, $PROFcaf) if $PROFcaf;
865 push(@HsC_flags, $PROFdict) if $PROFdict;
867 $Oopt_FinalStgProfilingMassage = '-fmassage-stg-for-profiling';
869 # Ignore user sccs when auto annotating, but warn when doing so.
870 $PROFignore_scc = '-W' if $PROFauto;
872 #if ( $BuildTag ne '' ) {
873 # local($b) = $BuildDescr{$BuildTag};
874 # if ($PARing eq 'p') { print STDERR "$Pgm: Can't mix $b with -parallel.\n"; exit 1; }
875 # if ($GRANing eq 'g') { print STDERR "$Pgm: Can't mix $b with -gransim.\n"; exit 1; }
876 # if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix $b with -ticky.\n"; exit 1; }
878 # # ok to have a user-way profiling build
879 # # eval the profiling opts ... but leave user-way BuildTag
880 # if ($PROFing eq 'p') { &processArgs(split(' ', $SetupOpts{'_p'})); } # eval($EvaldSetupOpts{'_p'}); }
882 if ( $PROFing eq 'p' ) {
883 if ($PARing eq 'p') { print STDERR "$Pgm: Can't do profiling with -parallel.\n"; exit 1; }
884 if ($GRANing eq 'g') { print STDERR "$Pgm: Can't do profiling with -gransim.\n"; exit 1; }
885 if ($TICKYing eq 't') { print STDERR "$Pgm: Can't do profiling with -ticky.\n"; exit 1; }
888 } elsif ( $PARing eq 'p' ) {
889 if ($GRANing eq 'g') { print STDERR "$Pgm: Can't mix -parallel with -gransim.\n"; exit 1; }
890 if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix -parallel with -ticky.\n"; exit 1; }
893 if ( $Do_lnkr && ( ! $ENV{'PVM_ROOT'} || ! $ENV{'PVM_ARCH'} )) {
894 print STDERR "$Pgm: both your PVM_ROOT and PVM_ARCH environment variables must be set for linking under -parallel.\n";
898 } elsif ( $GRANing eq 'g' ) {
899 if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix -gransim with -ticky.\n"; exit 1; }
902 } elsif ( $TICKYing eq 't' ) {
905 } elsif ( $UNREGing eq 'u' ) {
906 if ($GhcWithRegisterised eq 'YES') {
912 After the sanity checks, add flags to the necessary parts of the driver pipeline:
915 if ( $BuildTag ne '' ) { # something other than normal sequential...
917 local($Tag) = "${BuildTag}";
918 $Tag =~ s/_//; # move the underscore to the back
920 $HscOut = '-C='; # must go via C
921 &processArgs(split(' ', $SetupOpts{$BuildTag}));
922 # eval($EvaldSetupOpts{$BuildTag});
926 Decide what the consistency-checking options are in force for this run:
929 $HsC_consist_options = "${BuildTag},${DEBUGging}";
930 $Cc_consist_options = "${BuildTag},${DEBUGging}";
933 # Funny place to put it, but why not.
935 if ( $HiSuffix_prelude eq '' ) {
937 if ($CompilingPrelude) {
938 $HiSuffix_prelude = "$HiSuffix" if $CompilingPrelude;
940 local($Tag) = "${BuildTag}";
943 $Tag = "${Tag}_" if $Tag ne '';
944 $HiSuffix_prelude="${Tag}hi";
950 %************************************************************************
952 \subsection{Add on machine-specific C-compiler flags}
954 %************************************************************************
956 Shove on magical machine-specific options. We use \tr{unshift} to
957 stick them on the {\em front} of the arrays, so that ``later''
958 user-specified flags can clobber them (e.g., \tr{-U__STG_REV_TBLS__}).
960 Note: a few ``always apply'' flags were set at the very beginning.
965 if ($TargetPlatform =~ /^alpha-/) {
966 unshift(@CcBoth_flags, ('-static'));
968 } elsif ($TargetPlatform =~ /^hppa/) {
969 unshift(@CcBoth_flags, ('-static'));
971 # We don't put in '-mlong-calls', because it's only
972 # needed for very big modules (sigh), and we don't want
973 # to hobble ourselves further on all the other modules
976 # [Dated comment (gcc-2.6.x?), -mlong-calls is no longer
977 # a supported gcc HPPA flag]
978 unshift(@CcBoth_flags, ('-D_HPUX_SOURCE'));
979 # ___HPUX_SOURCE, not _HPUX_SOURCE, is #defined if -ansi!
980 # (very nice, but too bad the HP /usr/include files don't agree.)
982 } elsif ($TargetPlatform =~ /^i386-/) {
983 # -fno-defer-pop : basically the same game as for m68k
985 # -fomit-frame-pointer : *must* in .hc files; because we're stealing
986 # the fp (%ebp) for our register maps.
988 unshift(@CcRegd_flags_hc, '-fno-defer-pop');
989 unshift(@CcRegd_flags_hc, '-fomit-frame-pointer');
990 unshift(@CcRegd_flags, "-DSTOLEN_X86_REGS=$StolenX86Regs");
992 unshift(@CcBoth_flags, ('-DDONT_WANT_WIN32_DLL_SUPPORT')) if ($Static);
994 } elsif ($TargetPlatform =~ /^m68k-/) {
995 # -fno-defer-pop : for the .hc files, we want all the pushing/
996 # popping of args to routines to be explicit; if we let things
997 # be deferred 'til after an STGJUMP, imminent death is certain!
999 # -fomit-frame-pointer : *don't*
1000 # It's better to have a6 completely tied up being a frame pointer
1001 # rather than let GCC pick random things to do with it.
1002 # (If we want to steal a6, then we would try to do things
1003 # as on iX86, where we *do* steal the frame pointer [%ebp].)
1005 unshift(@CcRegd_flags_hc, '-fno-defer-pop');
1006 unshift(@CcRegd_flags, '-fno-omit-frame-pointer');
1007 # maybe gives reg alloc a better time
1008 # also: -fno-defer-pop is not sufficiently well-behaved without it
1010 } elsif ($TargetPlatform =~ /^mips-/) {
1011 unshift(@CcBoth_flags, ('-static'));
1013 } elsif ($TargetPlatform =~ /^powerpc-|^rs6000-/) {
1014 unshift(@CcBoth_flags, ('-static')); # always easier to start with
1015 unshift(@CcRegd_flags, ('-finhibit-size-directive')); # avoids traceback tables
1016 } elsif ($TargetPlatform =~ /^sparc-/) {
1018 } # end of setupMachOpts
1021 %************************************************************************
1023 \subsection{Set up for warnings}
1025 %************************************************************************
1027 Several warnings are turned on by default. These are supposed to be
1028 the 'I'm pretty sure you've made a mistake here' kind of warnings.
1029 The rest are turned on by the -W and -Wall options, or individually
1030 via their -fwarn and -fno-warn flags.
1033 sub setupWarningFlags {
1034 &add_Hsc_flags( @StandardWarnings );
1038 Same unshifting magic, but for special linker flags.
1040 The configure script determines whether the object file symbol tables
1041 have a leading underscore, and sets @LeadingUnderscore@ accordingly.
1042 (The driver script `sees' the setting of the @LeadingUnderscore@
1043 by having the Makefile prepend it).
1047 local($uscore) = ( ${LeadingUnderscore} eq 'YES' ) ? '_' : '';
1050 (($Ld_main) ? ( '-u', "${uscore}Main_" . $Ld_main . '_closure' ) : ()));
1052 # things that are referenced by the RTS - make sure that we pull 'em in
1054 ( '-u', "${uscore}PrelBase_Izh_static_info"
1055 ,'-u', "${uscore}PrelBase_Czh_static_info"
1056 ,'-u', "${uscore}PrelBase_Fzh_static_info"
1057 ,'-u', "${uscore}PrelBase_Dzh_static_info"
1058 ,'-u', "${uscore}PrelAddr_Azh_static_info"
1059 ,'-u', "${uscore}PrelAddr_Wzh_static_info"
1060 ,'-u', "${uscore}PrelAddr_I64zh_static_info"
1061 ,'-u', "${uscore}PrelAddr_W64zh_static_info"
1062 ,'-u', "${uscore}PrelStable_StablePtr_static_info"
1063 ,'-u', "${uscore}PrelBase_Izh_con_info"
1064 ,'-u', "${uscore}PrelBase_Czh_con_info"
1065 ,'-u', "${uscore}PrelBase_Fzh_con_info"
1066 ,'-u', "${uscore}PrelBase_Dzh_con_info"
1067 ,'-u', "${uscore}PrelAddr_Azh_con_info"
1068 ,'-u', "${uscore}PrelAddr_Wzh_con_info"
1069 ,'-u', "${uscore}PrelAddr_I64zh_con_info"
1070 ,'-u', "${uscore}PrelAddr_W64zh_con_info"
1071 ,'-u', "${uscore}PrelStable_StablePtr_con_info"
1072 ,'-u', "${uscore}PrelBase_False_static_closure"
1073 ,'-u', "${uscore}PrelBase_True_static_closure"
1074 ,'-u', "${uscore}PrelPack_unpackCString_closure"
1075 ,'-u', "${uscore}PrelException_stackOverflow_closure"
1076 ,'-u', "${uscore}PrelException_heapOverflow_closure"
1078 if (!$NoHaskellMain) {
1079 unshift (@Ld_flags,'-u', "${uscore}PrelMain_mainIO_closure");
1081 if ($TargetPlatform =~ /^powerpc-|^rs6000-/) {
1082 # sometimes we have lots of toc entries...
1083 # unshift(@Ld_flags, ('-Xlinker -bbigtoc -Xlinker -bnoquiet'));
1084 unshift(@Ld_flags, ('-Xlinker -bbigtoc'));
1088 } # end of setupLinkOpts
1092 %************************************************************************
1094 \subsection{Set up include paths and system-library enslurpment}
1096 %************************************************************************
1098 Now that we know what garbage-collector, etc., are required, we can
1099 finalise our list of libraries to slurp through, and generally Get
1104 # default includes must be added AFTER option processing
1105 if ( ! $INSTALLING ) {
1106 push (@Include_dir, "$TopPwd/${CURRENT_DIR}/${GHC_INCLUDE_DIR}");
1108 push (@Include_dir, "$InstLibDirGhc/includes");
1109 push (@Include_dir, "$InstLibDirGhc/includes");
1111 } # end of setupIncPaths
1116 push(@SysLibrary, ( '-lHS', '-lHS_cbits' )); # basic I/O and prelude stuff
1119 foreach $f (@SysLibrary) {
1120 next if $f =~ /_cbits/;
1121 $f .= $BuildTag if $f =~ /^-lHS/;
1124 # Push library HSrts, plus boring clib bit
1125 push(@SysLibrary, "-lHSrts${BuildTag}");
1128 # RTS compiled with cygwin32, uses the WinMM API
1129 # to implement the itimers, since cygwin.dll does not
1130 # support it. Only reqd. for `ways' that use itimers.
1132 push(@SysLibrary, '-lwinmm') if $TargetPlatform eq 'i386-unknown-cygwin32';
1133 # Note: currently only tested with mingw, may cause conflicts when linking
1135 push(@SysLibrary, '-lwsock32') if ($TargetPlatform =~ /-(mingw32|cygwin32)$/);
1137 # Push the pvm libraries
1138 if ($BuildTag eq '_mp') {
1139 $pvmlib = "$ENV{'PVM_ROOT'}/lib/$ENV{'PVM_ARCH'}";
1140 push(@SysLibrary, "-L$pvmlib", '-lgpvm3', '-lpvm3');
1141 if ( $ENV{'PVM_ARCH'} eq 'SUNMP' ) {
1142 push(@SysLibrary, '-lthread', '-lsocket', '-lnsl');
1143 } elsif ( $ENV{'PVM_ARCH'} eq 'SUN4SOL2' ) {
1144 push(@SysLibrary, '-lsocket', '-lnsl');
1148 # Push the GNU multi-precision arith lib; and the math library
1150 # If this machine has GMP already installed, then we'll get the installed
1151 # lib here, because presumably the one in the tree won't have been built.
1153 if ($LibGmp eq 'not-installed') {
1154 push(@SysLibrary, "-lgmp");
1156 push(@SysLibrary, "-l$LibGmp");
1159 push(@SysLibrary, '-lm') if !( $TargetPlatform =~ /^.*(cygwin32|mingw32)$/ );
1162 %************************************************************************
1164 \subsection{Check that this system was built to do what we are asking}
1166 %************************************************************************
1168 Before continuing we check that the appropriate build is available.
1171 #die "$Pgm: no BuildAvail?? $BuildTag\n" if $BuildDescr{$BuildTag} eq '' ; # sanity
1173 if ( $BuildDescr{$BuildTag} eq '' ) {
1174 print STDERR "$Pgm: a `", $BuildDescr{$BuildTag},
1175 "' \"build\" is not available with your GHC setup.\n";
1176 print STDERR "(It was not configured for it at your site.)\n";
1177 print STDERR $ShortUsage;
1181 } # end of setupSyslibs
1185 %************************************************************************
1187 \subsection{Final miscellaneous setup bits before we start going}
1189 %************************************************************************
1191 Record largest specific heapsize, if any.
1193 sub setupHeapStackSize {
1194 $Specific_heap_size = $Specific_heap_size * $Scale_sizes_by;
1195 push(@HsC_rts_flags, '-H'.$Specific_heap_size);
1196 $Specific_stk_size = $Specific_stk_size * $Scale_sizes_by;
1197 push(@HsC_rts_flags, "-K$Specific_stk_size");
1201 If no input or link files seen, then we let 'em feed in stdin; this is
1202 mainly for debugging.
1206 if ($#Input_file < 0 && $#Link_file < 0) {
1207 @Input_file = ( '-' );
1209 open(INF, "> $Tmp_prefix.hs") || &tidy_up_and_die(1,"Can't open $Tmp_prefix.hs\n");
1210 print STDERR "Enter your Haskell program, end with ^D (on a line of its own):\n" if -t;
1211 while (<STDIN>) { print INF $_; }
1212 close(INF) || &tidy_up_and_die(1,"Failed writing to $Tmp_prefix.hs\n");
1217 Tell the world who we are, if they asked.
1219 print STDERR "${ProjectName}, version ${ProjectVersion}, patchlevel ${ProjectPatchLevel}\n"
1223 %************************************************************************
1225 \section[Driver-main-loop]{Main loop: Process input files, and link if required}
1227 %************************************************************************
1229 Process the input files; don't continue with linking if there are
1230 problems (global variable @$Status@ non-zero).
1232 foreach $ifile (@Input_file) {
1233 &ProcessInputFile($ifile);
1236 # don't link if there were errors...
1237 if ( $Status > 0 ) {
1238 print STDERR $ShortUsage;
1243 # Link if appropriate.
1244 &runLinker() if $Do_lnkr;
1246 # that... that's all, folks!
1248 exit $Status; # will still be 0 if all went well
1251 %************************************************************************
1253 \section[Driver-do-one-file]{How to process a single input file}
1255 %************************************************************************
1258 sub ProcessInputFile {
1259 local($ifile) = @_; # input file name
1260 local($ifile_root); # root of or basename of input file
1261 local($ofile_target); # ultimate output file we hope to produce
1262 # from input file (need to know for recomp
1263 # checking purposes)
1264 local($hifile_target);# ditto (but .hi file)
1265 local($ofile_c_stub_target);
1266 local($ofile_h_stub_target);
1269 Handle the weirdity of input from stdin.
1271 if ($ifile ne '-') {
1272 ($ifile_root = $ifile) =~ s/\.[^\.\/]+$//;
1273 $ofile_target = # may be reset later...
1274 ($Specific_output_file ne '' && ! $Do_lnkr)
1275 ? $Specific_output_file
1276 : &odir_ify($ifile_root, 'o');
1277 $hifile_target= ($Specific_hi_file ne '')
1279 : "$ifile_root.$HiSuffix"; # ToDo: odirify?
1280 # NB: may change if $ifile_root isn't module name (??)
1281 ($ofile_c_stub_target = $ifile) =~s/\.[^\.\/]+$/_stub.c/;
1282 ($ofile_h_stub_target = $ifile) =~s/\.[^\.\/]+$/_stub.h/;
1284 $ifile = "$Tmp_prefix.hs"; # we know that's where we put the input
1285 $ifile_root = '_stdin';
1286 $ofile_target = '_stdout'; # gratuitous?
1287 $hifile_target= '_stdout'; # ditto?
1291 We need to decide what phases of the compilation system we will run
1292 over this file. The defaults are the ones established when processing
1293 flags. (That established what the last phase run for all files is.)
1295 We do the pre-recompilation-checker phases here; the rest later.
1299 Look at the suffix and decide what initial phases of compilation may
1300 be dropped off for this file. Also the rather boring business of
1301 which files are coming-in/going-out.
1303 Again, we'll do the post-recompilation-checker parts of this later.
1305 local($do_lit2pgm) = ($ifile =~ /\.lhs$/) ? 1 : 0;
1306 local($do_hscpp) = 1; # but "hscpp" might really be "cat"
1309 # names of the files to stuff between phases
1310 # defaults are temporaries
1311 local($in_lit2pgm) = $ifile;
1312 local($lit2pgm_hscpp) = "$Tmp_prefix.lpp";
1313 local($hscpp_hsc) = "$Tmp_prefix.cpp";
1314 local($hsc_hi) = "$Tmp_prefix.hi";
1315 local($cc_as_o) = "${Tmp_prefix}_o.s"; # temporary for raw .s file if opt C
1316 local($cc_as) = "$Tmp_prefix.s"; # mangled or hsc-produced .s code
1317 local($as_out) = $ofile_target;
1319 local($is_hc_file) = 1; #Is the C code .hc or .c? Assume .hc for now
1321 # OK, let's strip off some literate junk..
1323 &runLit2pgm($in_lit2pgm, $lit2pgm_hscpp)
1325 $lit2pgm_hscpp = $ifile;
1331 # Scan the top of the de-litted file for {-# OPTIONS #-} pragmas
1332 &check_for_source_options($lit2pgm_hscpp,$ifile);
1334 # Options found in the source file take a back seat, i.e., we scan
1335 # them first. Only process the command line again if source file
1336 # contained anything of interest *or* there's more than one
1337 # input file (we have to reset the options).
1339 if ( $#Input_file >= 0 || $#File_options >= 0) {
1340 #@File_options = (@File_options, @Cmd_opts);
1342 # Now process the command line
1343 &initDriverGlobals();
1344 &processArgs((@File_options,@Cmd_opts));
1345 print STDERR "\nEffective command line: " .
1346 join(' ',(@File_options,@Cmd_opts)) . "\n" if $Verbose;
1349 # Having got the effective command line scanned, set up
1350 # the various options in prep for some real work.
1352 # check the sanity of the BuildTag we're about to use,
1353 # and if needs be, add some more flags and setup to
1354 # the different phases.
1357 &setupOptimiseFlags();
1360 &setupWarningFlags();
1361 &setupHeapStackSize();
1364 # These two variables need to be set after the
1365 # command-line has been processed and the build options
1366 # have be seen set up. This is because command-line options
1367 # can control whether to compile vias C or not.
1369 local($do_cc) = ( $Do_cc != -1) # i.e., it was set explicitly
1371 : ( ($HscOut eq '-C=') ? 1 : 0 );
1372 local($do_as) = $Do_as;
1373 local($hsc_out) = ( $HscOut eq '-C=' ) ? "$Tmp_prefix.hc" : "$Tmp_prefix.s" ;
1374 local($hsc_out_c_stub) = ( $HscOut eq '-C=' ) ? "${Tmp_prefix}_stb.c" : "";
1375 local($hsc_out_h_stub) = ( $HscOut eq '-C=' ) ? "${Tmp_prefix}_stb.h" : "";
1377 if ($Only_preprocess_hc) { # stop after having run $Cc -E
1380 if ($Only_preprocess_C) { # stop after having run $hscpp
1381 $do_hsc=0; $do_cc = 0; $do_as=0;
1382 } elsif ($ifile =~ /.lhs$/ || $ifile =~ /.hs$/ ) {
1384 } elsif ($ifile =~ /\.hc$/ || $ifile =~ /_hc$/ ) { # || $ifile =~ /\.$Isuffix$/o) # ToDo: better
1385 $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
1387 $hsc_out_c_stub = '';
1388 $hsc_out_h_stub = '';
1389 } elsif ($ifile =~ /\.c$/) {
1390 $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
1391 $hsc_out = $ifile; $is_hc_file = 0;
1392 $hsc_out_c_stub = '';
1393 $hsc_out_h_stub = '';
1394 } elsif ($ifile =~ /\.[sS]$/) {
1395 $do_hscpp = 0; $do_hsc = 0; $do_cc = 0;
1397 } else { # don't know what it is, but nothing to do herein...
1398 $do_hscpp = 0; $do_hsc = 0; $do_cc = 0; $do_as = 0;
1401 # hack to avoid running hscpp
1402 $HsCpp = $Cat if ! $Cpp_flag_set;
1404 &runHscpp($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc) if $do_hscpp;
1408 We now think about whether to run hsc/cc or not (when hsc produces .s
1409 stuff, it effectively takes the place of both phases).
1410 To get the output file name right: for each phase that we are {\em
1411 not} going to run, set its input (i.e., the output of its preceding
1412 phase) to @"$ifile_root.<suffix>"@.
1415 local($going_interactive) = $HscOut eq '-N=' || $ifile_root eq '_stdin';
1418 # Warning issued if -keep-hc-file-too is used without
1419 # -fvia-C (or the equivalent)
1421 if ( $HscOut ne '-C=' && $Keep_hc_file_too ) {
1422 print STDERR "$Pgm: warning: Native code generator to be used, -keep-hc-file-too will be ignored\n";
1425 if (! $do_cc && ! $do_as) { # stopping after hsc
1426 $hsc_out = ($Specific_output_file ne '')
1427 ? $Specific_output_file
1428 : &odir_ify($ifile_root, ($HscOut eq '-C=') ? 'hc' : 's');
1430 $ofile_target = $hsc_out; # reset
1433 if (! $do_as) { # stopping after gcc (or hsc)
1434 $cc_as = ($Specific_output_file ne '')
1435 ? $Specific_output_file
1436 : &odir_ify($ifile_root, ( $Only_preprocess_hc ) ? 'i' : 's');
1438 $ofile_target = $cc_as; # reset
1444 Now the Haskell compiler, C compiler, and assembler
1448 &runHscAndProcessInterfaces( $ifile, $hscpp_hsc, $ifile_root,
1449 $ofile_target, $hifile_target,
1450 $going_interactive);
1453 if (-f $hsc_out_h_stub) {
1454 &run_something("cp $hsc_out_h_stub $ofile_h_stub_target", 'Copy foreign export header file');
1457 if (-f $hsc_out_c_stub) {
1458 &run_something("cp $hsc_out_c_stub $ofile_c_stub_target", 'Copy foreign export C stubs');
1459 local ($hsc_out_s_stub);
1460 local ($hsc_out_o_stub);
1461 ($ofile_s_stub_target = $ofile_c_stub_target) =~ s/\.(.*)$/\.s/;
1462 ($ofile_o_stub_target = $ofile_c_stub_target) =~ s/\.(.*)$/\.o/;
1463 &runGcc (0, $ofile_c_stub_target, $ofile_s_stub_target);
1464 &runAs ($ofile_o_stub_target, $ofile_s_stub_target);
1466 # Bring the C stub protos into scope when compiling the .hc file.
1468 push (@CcInjects, "#include \"${hsc_out_h_stub}\"\n");
1469 # Hack - ensure that the stub .h file is included in the OPTIONS section
1470 # if the .hc file is saved.
1471 push (@File_options, "-#include \"${ofile_h_stub_target}\"\n");
1476 &runGcc ($is_hc_file, $hsc_out, $cc_as_o);
1477 &runMangler($is_hc_file, $cc_as_o, $cc_as, $ifile_root) if ! $Only_preprocess_hc;
1480 &split_asm_file($cc_as) if $do_as && $SplitObjFiles;
1482 # save a copy of the .s file..
1483 &saveIntermediate($ifile_root , "s" , $cc_as) if ($do_as && $Keep_s_file_too);
1484 &runAs($as_out, $ifile_root) if $do_as;
1487 Finally, decide what to queue up for linker input.
1489 # tentatively assume we will eventually produce linker input:
1490 push(@Link_file, &odir_ify($ifile_root, 'o'));
1492 #ToDo: local($or_isuf) = ($Isuffix eq '') ? '' : "|$Isuffix";
1494 if ( $ifile !~ /\.(lhs|hs|hc|c|s|a|S)$/ && $ifile !~ /_hc$/ ) {
1495 # There's sometimes confusion regarding .hi files; users
1496 # supplying them on the command line.
1497 if ( $ifile =~ /\.hi$/ ) {
1498 print STDERR "$Pgm: warning: found `$ifile' on command line; interface files should not be supplied here - ignoring it.\n";
1500 print STDERR "$Pgm: don't recognise suffix on `$ifile'; passing it through to linker\n";
1502 # oops; we tentatively pushed the wrong thing; fix & do the right thing
1503 pop(@Link_file); push(@Link_file, $ifile);
1507 } # end of ProcessInputFile
1510 %************************************************************************
1512 \section[Driver-run-phases]{Routines to run the various phases}
1514 %************************************************************************
1518 local($in_lit2pgm, $lit2pgm_hscpp) = @_;
1522 # Only add #line pragma if we're going to need it.
1523 $to_do = "echo '#line 1 \"$in_lit2pgm\"' > $lit2pgm_hscpp && " if ($Cpp_flag_set);
1524 $to_do .= "$Unlit @Unlit_flags $in_lit2pgm - >> $lit2pgm_hscpp";
1526 push(@Files_to_tidy, $lit2pgm_hscpp );
1528 &run_something($to_do, 'literate pre-processor');
1534 local($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc) = @_;
1538 # Strictly speaking, echoing of the following line pragma is only required
1539 # on non-delit'ed input, as we've already added it during de-lit. However,
1540 # hscpp will then add a {-# LINE 1 "$lit2pgm_hsc" -} to the top of the file,
1541 # which is not very informative (but harmless). Hence, we uniformly have
1542 # {-# LINE 1 "$in_lit2pgm" #-} as the first line to all cpp'ed hsc input.
1544 $to_do = "echo '{-# LINE 1 \"$in_lit2pgm\" -}' > $hscpp_hsc && ";
1546 if ($HsCpp eq $Cat) {
1547 $to_do .= "$HsCpp $lit2pgm_hscpp >> $hscpp_hsc";
1548 push(@Files_to_tidy, $hscpp_hsc );
1549 &run_something($to_do, 'Ineffective C pre-processor');
1551 local($includes) = '-I' . join(' -I',@Include_dir);
1552 $to_do .= "$HsCpp $Verbose @HsCpp_flags @HsSourceCppOpts $includes $lit2pgm_hscpp >> $hscpp_hsc";
1553 push(@Files_to_tidy, $hscpp_hsc );
1554 &run_something($to_do, 'Haskellised C pre-processor');
1557 if ( $Only_preprocess_C ) {
1558 $to_do = "$Cat $hscpp_hsc";
1559 &run_something($to_do, '');
1567 sub runHscAndProcessInterfaces {
1568 local($ifile, $hscpp_hsc, $ifile_root,
1569 $ofile_target, $hifile_target,
1570 $going_interactive) = @_;
1572 # $ifile is the original input file
1573 # $hscpp_hsc post-unlit, post-cpp, etc., input file
1574 # $ifile_root input filename minus suffix
1575 # $ofile_target the output file that we ultimately hope to produce
1576 # $hifile_target the .hi file ... (ditto)
1578 local($source_unchanged) = 1;
1580 # Check if the source file is up to date relative to the target; in
1581 # that case we say "source is unchanged" and let the compiler bail out
1582 # early if the import usage information allows it.
1584 ($i_dev,$i_ino,$i_mode,$i_nlink,$i_uid,$i_gid,$i_rdev,$i_size,
1585 $i_atime,$i_mtime,$i_ctime,$i_blksize,$i_blocks) = stat($ifile);
1587 # The informational messages below are now conditional on -v being set -- SOF
1588 if ( $ofile_target ne "_stdin.s" && ! -f $ofile_target ) {
1589 print STDERR "$Pgm:compile:Output file $ofile_target doesn't exist\n" if $Verbose;
1590 $source_unchanged = 0;
1593 ($o_dev,$o_ino,$o_mode,$o_nlink,$o_uid,$o_gid,$o_rdev,$o_size,
1594 $o_atime,$o_mtime,$o_ctime,$o_blksize,$o_blocks) = stat(_); # stat info from -f test
1596 if ( $hifile_target ne "_stdout" && ! -f $hifile_target ) {
1597 print STDERR "$Pgm:compile:Interface file $hifile_target doesn't exist\n" if $Verbose;
1598 $source_unchanged = 0;
1601 ($hi_dev,$hi_ino,$hi_mode,$hi_nlink,$hi_uid,$hi_gid,$hi_rdev,$hi_size,
1602 $hi_atime,$hi_mtime,$hi_ctime,$hi_blksize,$hi_blocks) = stat(_); # stat info from -f test
1604 if ( $ofile_target ne "_stdin.s" && $i_mtime > $o_mtime) {
1605 print STDERR "$Pgm:recompile:Input file $ifile newer than $ofile_target\n" if $Verbose;
1606 $source_unchanged = 0;
1609 # Tell the compiler which version we're using
1610 push(@HsC_flags, "-fhi-version=${ProjectVersionInt}");
1612 # So if source_unchanged is still "1", we pass on the good news to the compiler
1613 # The -recomp flag can disable this, forcing recompilation
1614 if ($Do_recomp_chkr && $source_unchanged) {
1615 push(@HsC_flags, '-fsource-unchanged');
1618 # Indicate whether we're static or not.
1619 # This will only ever
1620 push(@HsC_flags, '-static') if $Static;
1624 &runHsc($ifile_root, $hsc_out, $hsc_hi, $hsc_out_c_stub, $hsc_out_h_stub, $going_interactive);
1626 # See if it bailed out early, saying nothing needed doing.
1627 # We work this out by seeing if it created an output .hi file
1629 if ( ! -f $hsc_hi && $ProduceHi !~ /-nohifile=/ ) {
1630 # Doesn't exist, so we bailed out early.
1631 # Tell the C compiler and assembler not to run
1632 $do_cc = 0; $do_as = 0;
1634 # Update dependency info, touch both object file and
1635 # interface file, so that the following invariant is
1638 # a dependent module's interface file should after recompilation
1639 # checking be newer than the interface files of its imports.
1641 # That is, if module A's interface file changes, then module B
1642 # (which import from A) needs to be checked.
1643 # If A's change does not affect B, which causes the compiler to bail
1644 # out early, we still need to touch the interface file of B. The reason
1645 # for this is that B may export A's interface.
1647 &run_something("touch $ofile_target",
1648 "Touch $ofile_target, to propagate dependencies") if $HscOut ne '-N=';
1649 &run_something("touch $hifile_target",
1650 "Touch $hifile_target, to propagate dependencies") if $ProduceHi =~ /-nohifile=/ ;
1654 # Didn't bail out early (new .hi file) so we thunder on
1656 # If non-interactive, heave in the consistency info at the end
1657 # NB: pretty hackish (depends on how $output is set)
1658 if ( ! $going_interactive ) {
1659 if ( $HscOut eq '-C=' ) {
1660 $to_do = "echo 'static char ghc_hsc_ID[] = \"\@(#)hsc $ifile\t$HsC_major_version.$HsC_minor_version,$HsC_consist_options\";' >> $hsc_out";
1662 } elsif ( $HscOut eq '-S=' ) {
1663 local($consist) = "hsc.$ifile.$HsC_major_version.$HsC_minor_version.$HsC_consist_options";
1664 $consist =~ s/,/./g;
1665 $consist =~ s/\//./g;
1666 $consist =~ s/-/_/g;
1667 $consist =~ s/[^A-Za-z0-9_.]/ZZ/g; # ToDo: properly?
1668 $to_do = "echo '\n\t.text\n$consist:' >> $hsc_out";
1670 &run_something($to_do, 'Pin on Haskell consistency info');
1674 # Interface-handling is important enough to live off by itself
1675 if ( $ProduceHi !~ /-nohifile=/ ) { # If we've produced one, process it.
1676 require('ghc-iface.prl') || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-iface.prl!\n");
1677 &postprocessHiFile($hsc_hi, $hifile_target, $going_interactive);
1679 # if we're going to split up object files,
1680 # we inject split markers into the .hc file now
1681 if ( $HscOut eq '-C=' && $SplitObjFiles ) {
1682 &inject_split_markers ( $hsc_out );
1685 # save a copy of the .hc file, even if we are carrying on...
1686 if ($HscOut eq '-C=' && $do_cc && $Keep_hc_file_too) {
1687 &saveIntermediate($ifile_root , "hc" , $hsc_out);
1697 local($ifile_root, $hsc_out, $hsc_hi, $hsc_out_c_stub, $hsc_out_h_stub, $going_interactive) = @_;
1699 &makeHiMap() unless $HiMapDone;
1700 push(@HsC_flags, "-himap=$HiIncludeString");
1702 # here, we may produce .hc/.s and/or .hi files
1703 local($output) = '';
1704 #@Files_to_tidy = ();
1706 if ( $going_interactive ) {
1707 # don't need .hi unless we're going to show it on stdout:
1708 $ProduceHi = '-nohifile=' if ! ($HiOnStdout || $Specific_hi_file ne '' );
1709 $do_cc = 0; $do_as = 0; $Do_lnkr = 0; # and we won't go any further...
1712 # set up for producing output/.hi; note that flag twiddling
1713 # may mean that nothing will actually be produced:
1714 $output = "$ProduceHi$hsc_hi $HscOut$hsc_out -F=$hsc_out_c_stub -FH=$hsc_out_h_stub";
1715 push(@Files_to_tidy, $hsc_hi, $hsc_out, $hsc_out_c_stub, $hsc_out_h_stub );
1717 # if we're compiling foo.hs, we want the GC stats to end up in foo.stat
1718 if ( $CollectingGCstats ) {
1719 push(@HsC_rts_flags, "-S$ifile_root.stat");
1720 push(@Files_to_tidy, "$ifile_root.stat");
1723 if ( $CollectGhcTimings ) { # assume $RTS_style eq 'ghc'
1724 # emit nofibbish time/bytes-alloc stats to stderr;
1725 # see later .stat file post-processing
1726 print STDERR "warning: both -Rgc-stats and -Rghc-timing used, -Rghc-timing wins." if $CollectingGCstats;
1727 push(@HsC_rts_flags, "-s$Tmp_prefix.stat");
1728 push(@Files_to_tidy, "$Tmp_prefix.stat");
1732 if ($Specific_dump_file ne '') {
1733 $dump = "2>> $Specific_dump_file";
1734 $Using_dump_file = 1;
1738 # Win32 only: If the command processor used by system()
1739 # exec()s the application as an ordinary Win32 executable,
1740 # we're in trouble here, since the command line is likely
1741 # to be > 255 chars long. To work around this situation,
1742 # $HsC also understands `at-files', i.e., `@file' on the
1743 # command line will cause $HsC to add the contents of `file'
1744 # to the command line.
1746 # [ Note: support for `at-files' is not compiled in by default ]
1747 $cmd_line_opts_via_at_file=0;
1748 if ($cmd_line_opts_via_at_file) {
1750 local($to_do_opts) = "$Tmp_prefix.opts";
1751 open(OPTS, "> $Tmp_prefix.opts") || &tidy_up_and_die(1,"Can't open $Tmp_prefix.opts\n");
1752 print OPTS "$dump @HsC_flags $CoreLint $USPLint $StgLint $Verbose";
1754 $to_do = "$HsC $hscpp_hsc \@$Tmp_prefix.opts $output +RTS @HsC_rts_flags";
1758 $to_do = "$HsC $hscpp_hsc $dump @HsC_flags $CoreLint $USPLint $StgLint $Verbose $output +RTS @HsC_rts_flags";
1760 &run_something($to_do, 'Haskell compiler');
1762 # finish business w/ nofibbish time/bytes-alloc stats
1763 &process_ghc_timings() if $CollectGhcTimings;
1767 Use \tr{@Import_dir} and \tr{@SysImport_dir} to make a tmp file
1768 of (module-name, pathname) pairs, one per line, separated by a space.
1771 $HiIncludeString = (); # dir1:dir2:dir3, to pass to GHC
1775 # collect in %HiMap; write later; also used elsewhere in driver
1777 local($mod, $path, $d, $e);
1779 # reset the global variables:
1781 $HiIncludeString = (); # dir1:dir2:dir3, to pass to GHC
1783 foreach $d ( @Import_dir ) {
1784 if ($HiIncludeString) {
1785 $HiIncludeString = "$HiIncludeString:${d}%.${HiSuffix}";
1787 $HiIncludeString = "$d%.${HiSuffix}";
1792 foreach $d ( @SysImport_dir ) {
1793 if ($HiIncludeString) {
1794 $HiIncludeString = "$HiIncludeString:${d}%.${HiSuffix_prelude}";
1796 $HiIncludeString = "${d}%.${HiSuffix_prelude}";
1805 Invoke the 'linker' - either the standard linker or the one used to build
1811 local($libdirs) = '';
1813 # append last minute flags linker and consistency flags
1818 # glue them together:
1819 push(@UserLibrary_dir, @SysLibrary_dir);
1821 $libdirs = '-L' . join(' -L',@UserLibrary_dir) if $#UserLibrary_dir >= 0;
1823 # for a linker, use an explicitly given one, or the going C compiler ...
1824 local($lnkr) = ( $Lnkr ) ? $Lnkr : $CcRegd;
1826 if ( ($Specific_output_file eq '') &&
1827 ($TargetPlatform eq 'i386-unknown-cygwin32') ) {
1828 $Specific_output_file = 'main.exe';
1829 print STDERR "Output file not specified, defaulting to \"main.exe\"\n";
1832 local($output) = ($Specific_output_file ne '') ? "-o $Specific_output_file" : '';
1833 @Files_to_tidy = ($Specific_output_file ne '') ? $Specific_output_file : 'a.out';
1835 &prepareWin32DllLink(1);
1837 local($to_do) = "$lnkr $Verbose @Ld_flags $output @Link_file $TopClosureFile $libdirs @UserLibrary @SysLibrary";
1838 &run_something($to_do, 'Linker');
1840 # finally, check the consistency info in the binary
1841 local($executable) = $Files_to_tidy[0];
1842 @Files_to_tidy = (); # reset; we don't want to nuke it if it's inconsistent
1845 # dynamically load consistency-chking code; then do it.
1846 require('ghc-consist.prl')
1847 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-consist.prl!\n");
1849 &chk_consistency_info ( $executable );
1852 # if PVM parallel stuff, we do truly weird things.
1853 # Essentially: (1) move the executable over to where PVM expects
1854 # to find it. (2) create a script in place of the executable
1855 # which will cause the program to be run, via SysMan.
1856 if ( $PARing eq 'p' ) {
1857 local($pvm_executable) = $executable;
1858 local($pvm_executable_base);
1860 if ( $pvm_executable !~ /^\// ) { # a relative path name: make absolute
1861 local($pwd) = `pwd`;
1863 $pwd =~ s/^\/tmp_mnt//;
1864 $pvm_executable = "$pwd/$pvm_executable";
1867 $pvm_executable =~ s|/|=|g; # make /s into =s
1868 $pvm_executable_base = $pvm_executable;
1870 $pvm_executable = $ENV{'PVM_ROOT'} . '/bin/' . $ENV{'PVM_ARCH'}
1871 . "/$pvm_executable";
1873 &run_something("$Rm -f $pvm_executable; $Cp -p $executable $pvm_executable && $Rm -f $executable", 'Moving binary to PVM land');
1875 # OK, now create the magic script for "$executable"
1876 open(EXEC, "> $executable") || &tidy_up_and_die(1,"$Pgm: couldn't open $executable to write!\n");
1877 print EXEC <<EOSCRIPT1;
1878 eval 'exec perl -S \$0 \${1+"\$@"}'
1879 if \$running_under_some_shell;
1880 # =!=!=!=!=!=!=!=!=!=!=!
1881 # This script is automatically generated: DO NOT EDIT!!!
1882 # Generated by Glasgow Haskell, version ${ProjectVersion} ${ProjectPatchLevel}
1884 \$pvm_executable = '$pvm_executable';
1885 \$pvm_executable_base = '$pvm_executable_base';
1886 \$SysMan = '$SysMan';
1889 print EXEC <<\EOSCRIPT2;
1890 # first, some magical shortcuts to run "commands" on the binary
1892 if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {
1894 system("$cmd $pvm_executable");
1898 # OK, really run it; process the args first
1899 $ENV{'PE'} = $pvm_executable_base;
1901 $nprocessors = 2; # the default
1905 # ToDo: handle --RTS
1906 args: while ($a = shift(@ARGV)) {
1907 if ( $a eq '+RTS' ) {
1909 } elsif ( $a eq '-RTS' ) {
1912 if ( $a eq '-d' && $in_RTS_args ) {
1914 } elsif ( $a =~ /^-N(\d+)/ && $in_RTS_args ) {
1917 push(@nonPVM_args, $a);
1921 local($return_val) = 0;
1922 system("$SysMan $debug $pvm_executable $nprocessors @nonPVM_args");
1924 system("mv $ENV{'HOME'}/$pvm_executable_base.???.gr .") if -f "$ENV{'HOME'}/$pvm_executable_base.001.gr";
1927 close(EXEC) || die "Failed closing $executable\n";
1928 chmod 0755, $executable;
1932 sub createWin32DLL()
1936 # append last minute flags linker and consistency flags
1941 # glue them together:
1942 push(@UserLibrary_dir, @SysLibrary_dir);
1944 $libdirs = '-L' . join(' -L',@UserLibrary_dir) if $#UserLibrary_dir >= 0;
1946 &prepareWin32DllLink(0);
1948 local ($bld_dll) = "dllwrap";
1950 local ($output) = ($Specific_output_file ne '') ? "$Specific_output_file" : 'HSdll.dll';
1951 local ($output_dir);
1952 local ($output_file);
1953 local ($output_lib, $output_def);
1955 ($output_dir = $output) =~ s|(.*/)[^/]+$|$1|;
1956 $output_dir = "" if ($output_dir eq $output);
1957 ($output_file = $output) =~ s|.*/([^/]+)$|$1|;
1959 ($output_lib = $output_file) =~ s|(.+)\.[^\.]*$|${output_dir}lib$1_imp.a|;
1960 ($output_def = $output_file) =~ s|(.+)\.[^\.]*$|${output_dir}$1.def|;
1962 push (@Dll_flags, "-mno-cygwin --target=i386-mingw32") if ($TargetPlatform =~ /^.*mingw32$/);
1963 push (@Dll_flags, "--output-lib $output_lib");
1964 # If the "--def " option hasn't been supplied, assume everything
1965 # is going to be exported via the DLL.."
1966 if (!grep(/--def/, @Dll_flags)) {
1967 push (@Dll_flags, "--export-all --output-def $output_def");
1970 local($to_do) = "$bld_dll @Dll_flags -o $output @Link_file $libdirs @UserLibrary @SysLibrary";
1971 # Make sure the user sees this piece of magic.
1972 print STDERR "$to_do\n" if (!$Verbose);
1973 &run_something($to_do, 'DLL creator');
1976 sub prepareWin32DllLink ()
1978 local($linking_main) = @_;
1981 # Win32 DLLs - link with import libraries, not the real archives.
1983 if ( $TargetPlatform =~ /-mingw32$/ ) {
1986 # If the libraries have the form libHSfoo.a, we
1987 # transform that into libHSfoo_imp.a - the import
1988 # library of the DLL.
1990 foreach $a ( @SysLibrary ) {
1991 $a = "${a}_imp" if ($a =~ /^-lHS/);
1993 foreach $a ( @UserLibrary ) {
1994 $a = "${a}_imp" if ($a =~ /^-lHS/);
1996 push(@Link_file, ( $INSTALLING ) ? "$InstLibDirGhc/Main.o"
1997 : "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR/Main.o") if $linking_main;
1998 push(@Link_file, ( $INSTALLING ) ? "$InstLibDirGhc/PrelMain.o"
1999 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/PrelMain.o") if $linking_main;
2001 push(@Ld_flags, "-mno-cygwin");
2007 %************************************************************************
2009 \section[Driver-misc-utils]{Miscellaneous utilities}
2011 %************************************************************************
2013 %************************************************************************
2015 \subsection[Driver-odir-ify]{@odir_ify@: Mangle filename if \tr{-odir} set}
2017 %************************************************************************
2021 local($ofile,$def_suffix) = @_;
2023 return(($Osuffix eq '') ? "$ofile.$def_suffix" : "$ofile.$Osuffix" );
2027 local($orig_file, $def_suffix) = @_;
2028 if ($Specific_output_dir eq '') { # do nothing
2029 &osuf_ify($orig_file, $def_suffix);
2031 local ($orig_file_only);
2032 ($orig_file_only = $orig_file) =~ s|.*/||;
2033 &osuf_ify("$Specific_output_dir/$orig_file_only",$def_suffix);
2040 local($is_hc_file, $hsc_out, $cc_as_o) = @_;
2042 local($includes) = '-I' . join(' -I', @Include_dir);
2045 local($c_flags) = "@CcBoth_flags";
2046 local($ddebug_flag) = ( $DEBUGging ) ? '-DDEBUG' : '';
2048 $c_flags .= " -mno-cygwin" if ( $TargetPlatform =~ /-mingw32$/ );
2050 # "input" files to use that are not in some weird directory;
2051 # to help C compilers grok .hc files [ToDo: de-hackify]
2052 local($cc_help) = "ghc$$.c";
2053 local($cc_help_s) = "ghc$$.s";
2056 $s_output = (($is_hc_file && $DoAsmMangling) || $TargetPlatform =~ /^(powerpc|rs6000|hppa)/) ? $cc_as_o : $cc_as;
2057 $c_flags .= " @CcRegd_flags";
2058 $c_flags .= ($is_hc_file) ? " @CcRegd_flags_hc" : " @CcRegd_flags_c";
2060 # C compiler won't like the .hc extension. So we create
2061 # a tmp .c file which #include's the needful.
2062 open(TMP, "> $cc_help") || &tidy_up_and_die(1,"$Pgm: failed to open `$cc_help' (to write)\n");
2063 if ( $is_hc_file ) {
2067 # user may have asked for #includes to be injected...
2068 print TMP @CcInjects if $#CcInjects >= 0;
2070 # Straight .c files may want to know that they're being used
2071 # with a particular version of GHC, so we define __GLASGOW_HASKELL__ for their benefit.
2072 print TMP "#define __GLASGOW_HASKELL__ ${ProjectVersionInt}\n";
2074 # heave in the consistency info
2075 print TMP "static char ghc_cc_ID[] = \"\@(#)cc $ifile\t$Cc_major_version.$Cc_minor_version,$Cc_consist_options\";\n";
2077 print TMP "#include \"$hsc_out\"\n";
2078 close(TMP) || &tidy_up_and_die(1,"Failed writing to $cc_help\n");
2080 # Don't redirect stderr into intermediate file if slamming output onto stdout (e.g., with -E)
2081 local($fuse_stderr) = "2>&1" if ! $Only_preprocess_hc;
2082 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 )";
2084 if ( $Only_preprocess_hc ) { # HACK ALERT!
2085 $to_do =~ s/ -S\b//g;
2087 push(@Files_to_tidy, $cc_help, $cc_help_s, $s_output );
2088 $PostprocessCcOutput = 1 if ! $Only_preprocess_hc; # hack, dear hack...
2089 &run_something($to_do, 'C compiler');
2090 $PostprocessCcOutput = 0;
2091 if ( $Only_preprocess_hc ) {
2092 system("$Cat $Tmp_prefix.ccout");
2094 unlink($cc_help, $cc_help_s);
2100 local($is_hc_file, $cc_as_o, $cc_as, $ifile_root) = @_;
2102 print STDERR `cat $cc_as_o` if $Dump_raw_asm; # to stderr, before mangling
2104 if ($is_hc_file && $DoAsmMangling) {
2105 # dynamically load assembler-fiddling code, which we are about to use:
2106 require('ghc-asm.prl')
2107 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm.prl!\n");
2108 # post-process the assembler [.hc files only]
2109 &mangle_asm($cc_as_o, $cc_as);
2111 } elsif ($TargetPlatform =~ /^hppa/) {
2112 # minor mangling of non-threaded files for hp-pa only
2113 require('ghc-asm.prl')
2114 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-hppa.prl!\n");
2115 &mini_mangle_asm_hppa($cc_as_o, $cc_as);
2117 } elsif ($TargetPlatform =~ /^powerpc|^rs6000/) {
2118 # minor mangling of non-threaded files for powerpcs and rs6000s
2119 require('ghc-asm.prl')
2120 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-powerpc.prl!\n");
2121 &mini_mangle_asm_powerpc($cc_as_o, $cc_as);
2124 # save a copy of the .s file, even if we are carrying on...
2125 #if ($do_as && $Keep_s_file_too) {
2126 # &saveIntermediate($ifile_root , "s" , $cc_as);
2133 local($as_out, $ifile_root) = @_;
2135 local($asmblr) = ( $As ) ? $As : $CcRegd;
2137 # need to add the -I flags in case the file is going through cpp (.S files)
2138 local($includes) = '-I' . join(' -I', @Include_dir);
2140 if ( ! $SplitObjFiles ) {
2141 local($to_do) = "$asmblr -o $as_out -c @As_flags $includes $cc_as";
2142 push(@Files_to_tidy, $as_out );
2143 &run_something($to_do, 'Unix assembler');
2145 } else { # more complicated split-ification...
2147 # must assemble files $Tmp_prefix__[1 .. $NoOfSplitFiles].s
2149 # If -odir is used, great, just pin it in front of the
2150 # generated split file names. If it hasn't been set, we
2151 # snatch it from the ifile_root.
2155 if ( $Specific_output_dir eq '' ) {
2156 $Specific_output_dir = ${ifile_root};
2159 for ($f = 1; $f <= $NoOfSplitFiles; $f++ ) {
2160 local($split_out) = &odir_ify("${ifile_root}__${f}",'o');
2161 local($to_do) = "$asmblr -o $split_out -c @As_flags ${Tmp_prefix}__${f}.s";
2162 push(@Files_to_tidy, $split_out );
2164 &run_something($to_do, 'Unix assembler');
2170 %************************************************************************
2172 \subsection[Driver-run-something]{@run_something@: Run a phase}
2174 %************************************************************************
2178 local($str_to_do, $tidy_name) = @_;
2180 print STDERR "\n$tidy_name:\n\t" if $Verbose;
2181 print STDERR "$str_to_do\n" if $Verbose;
2183 if ($Using_dump_file) {
2184 open(DUMP, ">> $Specific_dump_file")
2185 || &tidy_up_and_die(1,"$Pgm: failed to open `$Specific_dump_file'\n");
2186 print DUMP "\nCompilation Dump for: $str_to_do\n\n";
2188 || &tidy_up_and_die(1,"$Pgm: failed closing `$Specific_dump_file'\n");
2191 local($return_val) = 0;
2193 if ( length($str_to_do) > 4000) {
2194 # 4000 - on the random side, just like the *real* ARG_MAX
2197 # With some shells, command lines of this length may
2198 # very well cause trouble. To safeguard against this, we squirrel the
2199 # command into a file and exec that.
2200 local ($sh) = $ENV{'REAL_SHELL'};
2201 print STDERR "Backup plan A: saving cmd line in ${Tmp_prefix}.sh and executing that with $sh\n" if $Verbose;
2202 open (TEMP, "> ${Tmp_prefix}.sh") ||
2203 &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.sh'\n");
2204 print TEMP "$Time $str_to_do\n";
2206 &tidy_up_and_die(1,"$Pgm: failed closing `$Tmp_prefix.sh'\n");
2207 system("$sh $Tmp_prefix.sh");
2210 unlink "${Tmp_prefix}.sh";
2212 system("$Time $str_to_do");
2216 if ( $PostprocessCcOutput ) { # hack, continued
2217 open(CCOUT, "< $Tmp_prefix.ccout")
2218 || &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.ccout'\n");
2220 next if /call-clobbered/;
2221 next if /control reaches end/;
2222 next if /from .*Stg\.h:/;
2223 next if /from ghc\d+.c:\d+:/;
2224 next if /: At top level:$/;
2225 next if /: In function \`.*\':$/;
2226 next if /\`ghc_cc_ID\' defined but not used/;
2229 close(CCOUT) || &tidy_up_and_die(1,"$Pgm: failed closing `$Tmp_prefix.ccout'\n");
2232 if ($return_val != 0) {
2233 if ($Using_dump_file) {
2234 print STDERR "Compilation Errors dumped in $Specific_dump_file\n";
2236 &tidy_up_and_die($return_val, '');
2238 $Using_dump_file = 0;
2242 %************************************************************************
2244 \subsection[Driver-ghc-timing]{Emit nofibbish GHC timings}
2246 %************************************************************************
2248 NB: nearly the same as in @runstdtest@ script.
2251 sub process_ghc_timings {
2252 local($StatsFile) = "$Tmp_prefix.stat";
2253 local($SysSpecificTiming) = 'ghc';
2255 open(STATS, $StatsFile) || die "Failed when opening $StatsFile\n";
2256 local($max_live) = 0;
2257 local($tot_live) = 0; # for calculating residency stuff
2258 local($tot_samples) = 0;
2261 if (! /Gen:\s+0/ && ! /Minor/ && /^\s*\d+\s+\d+\s+(\d+)\s+\d+\.\d+/ ) {
2262 $max_live = $1 if $max_live < $1;
2266 $BytesAlloc = $1 if /^\s*([0-9,]+) bytes allocated in the heap/;
2268 if ( /^\s*([0-9,]+) bytes maximum residency .* (\d+) sample/ ) {
2269 $MaxResidency = $1; $ResidencySamples = $2;
2272 $GCs = $1 if /^\s*([0-9,]+) (collections? in generation 0|garbage collections? performed)/;
2274 if ( /^\s+([0-9]+)\s+Mb total memory/ ) {
2278 # The presence of -? in the following pattern is only there to
2279 # accommodate 0.29 && <= 2.05 RTS'
2280 if ( /^\s*INIT\s+time\s*(\d+\.\d\d)s\s*\(\s*-?(\d+\.\d\d)s elapsed\)/ ) {
2281 $InitTime = $1; $InitElapsed = $2;
2282 } elsif ( /^\s*MUT\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2283 $MutTime = $1; $MutElapsed = $2;
2284 } elsif ( /^\s*GC\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2285 $GcTime = $1; $GcElapsed = $2;
2288 close(STATS) || die "Failed when closing $StatsFile\n";
2289 if ( $tot_samples > 0 ) {
2290 $ResidencySamples = $tot_samples;
2291 $MaxResidency = $max_live;
2292 $AvgResidency = int ($tot_live / $tot_samples) ;
2295 # warn about what we didn't find
2296 print STDERR "Warning: BytesAlloc not found in stats file\n" unless defined($BytesAlloc);
2297 print STDERR "Warning: GCs not found in stats file\n" unless defined($GCs);
2298 print STDERR "Warning: InitTime not found in stats file\n" unless defined($InitTime);
2299 print STDERR "Warning: InitElapsed not found in stats file\n" unless defined($InitElapsed);
2300 print STDERR "Warning: MutTime not found in stats file\n" unless defined($MutTime);
2301 print STDERR "Warning: MutElapsed not found in stats file\n" unless defined($MutElapsed);
2302 print STDERR "Warning: GcTime inot found in stats file\n" unless defined($GcTime);
2303 print STDERR "Warning: GcElapsed not found in stats file\n" unless defined($GcElapsed);
2305 # things we didn't necessarily expect to find
2306 $MaxResidency = 0 unless defined($MaxResidency);
2307 $AvgResidency = 0 unless defined($AvgResidency);
2308 $ResidencySamples = 0 unless defined($ResidencySamples);
2311 $BytesAlloc =~ s/,//g;
2312 $MaxResidency =~ s/,//g;
2314 $InitTime =~ s/,//g;
2315 $InitElapsed =~ s/,//g;
2317 $MutElapsed =~ s/,//g;
2319 $GcElapsed =~ s/,//g;
2321 # print out what we found
2322 print STDERR "<<$SysSpecificTiming: ",
2323 "$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)",
2324 " :$SysSpecificTiming>>\n";
2331 %************************************************************************
2333 \subsection[Driver-dying]{@tidy_up@ and @tidy_up_and_die@: Dying gracefully}
2335 %************************************************************************
2339 local($to_do) = "\n$Rm $Tmp_prefix*";
2340 if ( $Tmp_prefix !~ /^\s*$/ ) {
2341 print STDERR "$to_do\n" if $Verbose;
2346 sub tidy_up_and_die {
2347 local($return_val, $msg) = @_;
2349 # delete any files to tidy
2350 print STDERR "deleting... @Files_to_tidy\n" if $Verbose && $#Files_to_tidy >= 0;
2351 unlink @Files_to_tidy if $#Files_to_tidy >= 0;
2355 exit (($return_val == 0) ? 0 : 1);
2359 %************************************************************************
2361 \subsection[Driver-arg-with-arg]{@grab_arg_arg@: Do an argument with an argument}
2363 %************************************************************************
2365 Some command-line arguments take an argument, e.g.,
2366 \tr{-Rmax-heapsize} expects a number to follow. This can either be
2367 given a part of the same argument (\tr{-Rmax-heapsize8M}) or as the
2368 next argument (\tr{-Rmax-heapsize 8M}). We allow both cases.
2370 Note: no error-checking; \tr{-Rmax-heapsize -Rgc-stats} will silently
2371 gobble the second argument (and probably set the heapsize to something
2375 local(*Args, $option, $rest_of_arg) = @_;
2377 if ($rest_of_arg ne '') {
2378 return($rest_of_arg);
2379 } elsif ($#Args >= 0) {
2380 local($temp) = $Args[0]; shift(@Args);
2383 print STDERR "$Pgm: no argument following $option option\n";
2394 #Not in HsC_antiflag ## NO!: and not already in HsC_flags
2396 foreach $f ( @HsC_antiflags ) {
2397 return(0) if $flag eq $f;
2399 # foreach $f ( @HsC_flags ) {
2400 # return(0) if $flag eq $f;
2405 sub squashHscFlag { # pretty terrible
2409 foreach $f ( @HsC_flags ) {
2410 if ($flag eq $f) { $f = ''; }
2418 foreach $f ( @flags ) {
2419 push( @HsC_flags, $f ) if &isntAntiFlag($f);
2424 To add another system library, you'll need to augment the
2425 Supported_syslibs variable with name and info on your addition
2426 to the syslib family. The info bit consist of the following:
2428 - interface file directory
2429 see the misc or posix entry for how to distinguish
2430 between using installed and build tree directories.
2432 - directory location of archives
2434 - location of (way-independent) C support libs.
2435 not all libraries need this - if you don't, just
2436 give the empty string.
2437 - list of syslibs you depend on.
2439 - additional ghc command line flags that should be used.
2440 - additional C compiler command line flags that should be used.
2446 # Hash to keep track of
2447 %Syslibs_added = ();
2450 local($syslib) = @_;
2452 # Lifting this out of this sub brings it out of scope - why??
2453 %Supported_syslibs =
2455 [ # where to slurp interface files from
2457 ? "$InstLibDirGhc/imports/exts"
2458 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/exts"
2460 , # where to find the archive to use when linking
2463 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/exts"
2466 , '' # Syslib dependencies
2467 , '' # extra ghc opts
2468 , '' # extra cc opts
2469 , '' # extra ld opts
2473 [ # where to slurp interface files from
2475 ? "$InstLibDirGhc/imports/misc"
2476 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/misc"
2478 , # where to find the archive to use when linking
2481 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/misc"
2483 , # where to find the cbits archive to use when linking
2486 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/misc/cbits"
2488 , 'exts' # Syslib dependencies
2489 , '' # extra ghc opts
2490 , '' # extra cc opts
2491 , ( $TargetPlatform =~ /-solaris2$/ ? '-lnsl -lsocket' : '')
2494 [ # where to slurp interface files from
2496 ? "$InstLibDirGhc/imports/hbc"
2497 : "$TopPwd/CONTRIB/libraries/hbc/src"
2499 , # where to find the archive to use when linking
2502 : "$TopPwd/CONTRIB/libraries/src/hbc"
2504 , # where to find the cbits archive to use when linking
2507 : "$TopPwd/CONTRIB/libraries/hbc/cbits"
2509 , 'exts' # Syslib dependencies
2510 , '' # extra ghc opts
2511 , '' # extra cc opts
2515 [ # where to slurp interface files from
2517 ? "$InstLibDirGhc/imports/posix"
2518 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/posix"
2520 , # where to find the archive to use when linking
2523 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/posix"
2525 , # where to find the cbits archive to use when linking
2528 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/posix/cbits"
2530 , 'misc' # Syslib dependencies
2531 , '' # extra ghc opts
2532 , '' # extra cc opts
2533 , '' # extra ld opts
2536 [ # where to slurp interface files from
2538 ? "$InstLibDirGhc/imports/concurrent"
2539 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/concurrent"
2541 , # where to find the archive to use when linking
2544 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/concurrent"
2546 , '' # where to find the cbits archive to use when linking
2547 , '' # Syslib dependencies
2548 , '' # extra ghc opts
2549 , '' # extra cc opts
2550 , '' # extra ld opts
2553 [ # where to slurp interface files from
2555 ? "$InstLibDirGhc/imports/win32"
2556 : "$TopPwd/hslibs/win32/src"
2558 , # where to find the archive to use when linking
2561 : "$TopPwd/hslibs/win32/src"
2564 , 'exts' # Syslib dependencies
2565 , '' # extra ghc opts
2566 , '' # extra cc opts
2567 , '-luser32 -lgdi32' # extra ld opts
2570 [ # where to slurp interface files from
2572 ? "$InstLibDirGhc/imports/com"
2573 : "$TopPwd/hdirect/lib"
2575 , # where to find the archive to use when linking
2578 : "$TopPwd/hdirect/lib"
2581 , 'exts' # Syslib dependencies
2582 , '' # extra ghc opts
2583 , '' # extra cc opts
2584 , '-luser32 -lole32 -loleaut32 -ladvapi32'
2589 # check if it's supported..
2591 if ( !exists $Supported_syslibs{$syslib} ) {
2592 print STDERR "$Pgm: no such system library (-syslib): $syslib\n";
2597 # This check is here to avoid syslib loops from
2598 # spoiling the party. A side-effect of it is that
2599 # it disallows multiple mentions of a syslib on a command-line,
2600 # explicit *and* implicit ones (i.e., "-syslib exts -syslib misc"
2601 # is not equal to "-syslib exts -syslib misc -syslib exts",
2602 # which it needs to be)
2604 # Since our current collection of syslibs don't have any
2605 # loops, this test is disabled.
2607 # ToDo: loop avoidance scheme when the need arises
2609 #return if ( exists $Syslibs_added{$syslib} );
2611 $Syslibs_added{$syslib} = 1;
2613 local ($hi_dir, $lib_dir, $lib_cbits_dir,
2614 $syslib_deps, $syslib_ghc_opts,
2615 $syslib_cc_opts, $syslib_ld_opts) = @{ $Supported_syslibs{$syslib} };
2618 unshift(@SysImport_dir, $hi_dir);
2619 push(@SysLibrary_dir, $lib_dir);
2620 push(@SysLibrary_dir, $lib_cbits_dir) if ( $lib_cbits_dir ne '');
2622 push(@SysLibrary, "-lHS$syslib");
2623 push(@SysLibrary, "-lHS${syslib}_cbits") if ( $lib_cbits_dir ne '');
2624 push(@SysLibrary, $syslib_ld_opts) if ($syslib_ld_opts ne '');
2626 # Add on any extra dependencies.
2627 foreach $lib (split(' ',$syslib_deps)) {
2633 Source files may have {-# OPTIONS ... #-} pragmas at the top, containing
2634 command line options we want to append to collection of commands specified
2635 directly. @check_for_source_options@ looks at the top of a de-lit'ified Haskell
2636 file for any such pragmas:
2639 sub check_for_source_options {
2640 local($file,$ifile) = @_;
2641 local($comment_start,$comment_end);
2643 if ($ifile =~ /\.hc$/ ||
2646 $ifile =~ /_s$/ ) { # `Real' C intermediate
2647 $comment_start = "/\\*";
2648 $comment_end = "\\*/";
2649 } else { # Assume it is a file containing Haskell source
2650 $comment_start = "{-#";
2651 $comment_end = "#-}";
2654 open(FILE,$file) || return(1); # No big loss
2657 if ( /^${comment_start} OPTIONS (.*)${comment_end}$/ ) {
2658 # add the options found at the back of the command line.
2659 local(@entries) = split(/\s+/,$1);
2660 print STDERR "Found OPTIONS " . join(' ',@entries) . " in $file\n" if $Verbose;
2661 push(@File_options, @entries);
2663 elsif ( /^$/ ) { # ignore empty lines
2666 elsif ( /^#line.+$/ ) { # ignore comment lines (unused..ToDo: rm )
2669 elsif ( /^{-# LINE.+$/ ) { # ignore line pragmas
2672 else { # stop looking, something non-empty / not
2673 # ${comment_start} OPTIONS .. ${comment_end} encountered.
2674 close(FILE);return(0);
2683 We split the initial argv up into three arrays:
2689 the reason for doing so is to be able to deal
2690 with {-# OPTIONS #-} pragma in source files properly.
2696 arg: while($_ = $args[0]) {
2698 # sigh, we have to deal with these -option arg specially here.
2699 /^-(tmpdir|odir|ohi|o|isuf|osuf|hisuf|odump|syslib)$/ &&
2700 do { push(@Cmd_opts, $_); push(@Cmd_opts,$args[0]); shift(@args); next arg; };
2701 /^--?./ && do { push(@Cmd_opts, $_); next arg; };
2703 if (/\.([^_]+_)?[oa]$/) {
2704 push(@Link_file, $_);
2706 push(@Input_file, $_);
2709 # input files must exist:
2711 print STDERR "$Pgm: input file doesn't exist: $_\n";
2719 When saving an intermediate file (.hc or .s) away, we
2720 have to prefix any OPTIONS found in the original source file.
2723 sub saveIntermediate {
2724 local ($final,$suffix,$tmp)= @_ ;
2727 # $final -- root of where to park ${final}.${suffix}
2728 # $tmp -- temporary file where hsc put the intermediate file.
2730 # Delete the old file
2731 $to_do = "$Rm ${final}.${suffix}"; &run_something($to_do, "Removing old .${suffix} file");
2733 if ( $#File_options >= 0 ) { # OPTIONS found in Haskell source unit
2734 # Add OPTION comment to the top of the generated .${suffix} file
2735 open(TEMP, "> ${final}.${suffix}") || &tidy_up_and_die(1,"Can't open ${final}.${suffix}\n");
2736 print TEMP "/* OPTIONS " . join(' ',@File_options) . " */\n";
2738 print STDERR "Prepending OPTIONS: " . join(' ',@File_options) . " to ${final}.${suffix}\n" if $Verbose;
2740 $to_do = "$Cat $tmp >> ${final}.${suffix}";
2741 &run_something($to_do, "Saving copy of .${suffix} file");
2748 Command-line processor
2754 # can't use getopt(s); what we want is too complicated
2756 arg: while($_ = $Args[0]) {
2759 #---------- help -------------------------------------------------------
2760 if (/^-\?$/ || /^--?help$/) { print $LongUsage; exit $Status; }
2762 #-----------version ----------------------------------------------------
2763 /^--version$/ && do { print STDERR "${ProjectName}, version ${ProjectVersion}, patchlevel ${ProjectPatchLevel}\n"; exit $Status; };
2765 #---------- verbosity and such -----------------------------------------
2766 /^-v$/ && do { $Verbose = '-v'; $Time = 'time'; next arg; };
2768 #---------- what phases are to be run ----------------------------------
2769 /^-(no-)?recomp/ && do { $Do_recomp_chkr = ($1 eq '') ? 1 : 0; next arg; };
2771 /^-cpp$/ && do { $Cpp_flag_set = 1; next arg; };
2772 # change the global default:
2773 # we won't run cat; we'll run the real thing
2775 /^-C$/ && do { $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0; $HscOut = '-C=';
2777 # stop after generating C
2779 /^-noC$/ && do { $HscOut = '-N='; $ProduceHi = '-nohifile=';
2780 $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0;
2782 # leave out actual C generation (debugging) [also turns off interface gen]
2785 /^-hi$/ && do { $HiOnStdout = 1; $ProduceHi = '-hifile='; next arg; };
2786 # _do_ generate an interface; usually used as: -noC -hi
2787 /^-hi-with-(.*)$/ && do { $HiOnStdout = 1; $HiWith .= " $1" ; $ProduceHi = '-hifile='; next arg; };
2788 # limit ourselves to outputting a particular section.
2790 /^-nohi$/ && do { $ProduceHi = '-nohifile='; next arg; };
2791 # don't generate an interface (even if generating C)
2793 /^-hi-diffs$/ && do { $HiDiff_flag = 'normal'; next arg; };
2794 /^-hi-diffs-with-usages$/ && do { $HiDiff_flag = 'usages'; next arg; };
2795 /^-no-hi-diffs$/ && do { $HiDiff_flag = ''; next arg; };
2796 /^-keep-hi-diffs$/ && do { $Keep_HiDiffs = 1; next arg; };
2798 # show/disable diffs if the interface file changes
2800 /^-E$/ && do { push(@CcBoth_flags, '-E');
2801 $Only_preprocess_C = 1;
2802 $Do_as = 0; $Do_lnkr = 0; next arg; };
2803 # stop after preprocessing C
2804 /^-M$/ && do { $Only_generate_deps = 1; $Do_as = 0; $Do_lnkr = 0; next arg; };
2805 # only generate dependency information.
2806 /^--mk-dll$/ && do { $Only_generate_dll = 1; $Do_as = 0; $Do_lnkr = 0; next arg; };
2807 # Build a Win32 DLL (where supported).
2808 /^-S$/ && do { $Do_as = 0; $Do_lnkr = 0; next arg; };
2809 # stop after generating assembler
2811 /^-c$/ && do { $Do_lnkr = 0; next arg; };
2812 # stop after generating .o files
2814 /^-link-chk$/ && do { $LinkChk = 1; next arg; };
2815 # don't do consistency-checking after a link
2816 /^-no-link-chk$/ && do { $LinkChk = 0; next arg; };
2818 /^-tmpdir$/ && do { $Tmp_prefix = &grab_arg_arg(*Args,'-tmpdir', '');
2819 $Tmp_prefix = "$Tmp_prefix/ghc$$";
2820 $ENV{'TMPDIR'} = $Tmp_prefix; # for those who use it...
2822 # use an alternate directory for temp files
2824 #---------- redirect output --------------------------------------------
2826 # -o <file>; applies to the last phase, whatever it is
2827 # "-o -" sends it to stdout
2828 # if <file> has a directory component, that dir must already exist
2830 /^-odir$/ && do { $Specific_output_dir = &grab_arg_arg(*Args,'-odir', '');
2832 # Hack, of the worst sort: don't do validation of
2833 # odir argument if you're using -M (dependency generation).
2835 if ( ! $Only_generate_deps && ! -d $Specific_output_dir) {
2836 print STDERR "$Pgm: -odir: no such directory: $Specific_output_dir\n";
2841 /^-o$/ && do { $Specific_output_file = &grab_arg_arg(*Args,'-o', '');
2842 if ($Specific_output_file ne '-'
2843 && $Specific_output_file =~ /(.*)\/[^\/]*$/) {
2844 local($dir_part) = $1;
2845 if (! -d $dir_part) {
2846 print STDERR "$Pgm: no such directory: $dir_part\n";
2852 # NB: -isuf not documented yet (because it doesn't work yet)
2853 /^-isuf$/ && do { $Isuffix = &grab_arg_arg(*Args,'-isuf', '');
2854 if ($Isuffix =~ /\./ ) {
2855 print STDERR "$Pgm: -isuf suffix shouldn't contain a .\n";
2860 /^-osuf$/ && do { $Osuffix = &grab_arg_arg(*Args,'-osuf', '');
2861 if ($Osuffix =~ /\./ ) {
2862 print STDERR "$Pgm: -osuf suffix shouldn't contain a .\n";
2867 # -ohi <file>; send the interface to <file>; "-ohi -" to send to stdout
2868 /^-ohi$/ && do { $Specific_hi_file = &grab_arg_arg(*Args,'-ohi', '');
2869 if ($Specific_hi_file ne '-'
2870 && $Specific_hi_file =~ /(.*)\/[^\/]*$/) {
2871 local($dir_part) = $1;
2872 if (! -d $dir_part) {
2873 print STDERR "$Pgm: no such directory: $dir_part\n";
2877 $ProduceHi='-hifile=';
2880 # The suffix to use when looking for interface files
2881 /^-hisuf$/ && do { $HiSuffix = &grab_arg_arg(*Args,'-hisuf', '');
2882 if ($HiSuffix =~ /\./ ) {
2883 print STDERR "$Pgm: -hisuf suffix shouldn't contain a .\n";
2887 /^-odump$/ && do { $Specific_dump_file = &grab_arg_arg(*Args,'-odump', '');
2888 if ($Specific_dump_file =~ /(.*)\/[^\/]*$/) {
2889 local($dir_part) = $1;
2890 if (! -d $dir_part) {
2891 print STDERR "$Pgm: no such directory: $dir_part\n";
2897 #-------------- scc & Profiling Stuff ----------------------------------
2899 /^-prof$/ && do { $PROFing = 'p'; next arg; }; # profiling -- details later!
2901 /^-auto-dicts$/ && do {
2902 $PROFdicts = '-fauto-sccs-on-dicts';
2904 /^-auto-all$/ && do {
2905 $PROFauto = '-fauto-sccs-on-all-toplevs';
2908 $PROFauto = '-fauto-sccs-on-exported-toplevs';
2911 /^-caf-all/ && do { # generate individual CAF SCC annotations
2912 $PROFcaf = '-fauto-sccs-on-individual-cafs';
2915 /^-ignore-scc$/ && do {
2916 # forces ignore of scc annotations even if profiling
2917 $PROFignore_scc = '-W';
2920 /^-G(.*)$/ && do { push(@HsC_flags, "-G=$1"); # set group for cost centres
2923 /^-unprof-scc-auto/ && do {
2924 # generate auto SCCs on top level bindings when not profiling.
2925 # Used to measure optimisation effects of presence of sccs.
2926 $UNPROFscc_auto = ( /-all/ )
2927 ? '-fauto-sccs-on-all-toplevs'
2928 : '-fauto-sccs-on-exported-toplevs';
2931 #--------- ticky/parallel ----------------------------------------------
2932 # we sort out the details a bit later on
2934 /^-gransim$/ && do { $GRANing = 'g'; &add_syslib('concurrent'); next arg; }; # GranSim
2935 /^-ticky$/ && do { $TICKYing = 't'; next arg; }; # ticky-ticky
2936 /^-parallel$/ && do { $PARing = 'p'; &add_syslib('concurrent'); next arg; }; # parallel Haskell
2938 #-------------- "user ways" --------------------------------------------
2940 (/^-user-setup-([a-oA-Z])$/ ) &&
2942 /^-user-setup-([a-oA-Z])$/ && do { $BuildTag = "_$1"; };
2944 local($stuff) = $UserSetupOpts{$BuildTag};
2945 local(@opts) = split(/\s+/, $stuff);
2947 # feed relevant ops into the arg-processing loop (if any)
2948 unshift(@Args, @opts) if $#opts >= 0;
2952 #---------- set search paths for libraries and things ------------------
2954 # we do -i just like HBC (-i clears the list; -i<colon-separated-items>
2955 # prepends the items to the list); -I is for including C .h files.
2957 /^-i$/ && do { @Import_dir = (); # import path cleared!
2958 @SysImport_dir = ();
2959 print STDERR "WARNING: import paths cleared by `-i'\n";
2962 /^-i(.*)/ && do { local(@new_items)
2963 = split( /:/, &grab_arg_arg(*Args,'-i', $1));
2964 unshift(@Import_dir, @new_items);
2967 /^-I(.*)/ && do { push(@Include_dir, &grab_arg_arg(*Args,'-I', $1)); next arg; };
2968 /^-L(.*)/ && do { push(@UserLibrary_dir, &grab_arg_arg(*Args,'-L', $1)); next arg; };
2969 /^-l(.*)/ && do { push(@UserLibrary,'-l'.&grab_arg_arg(*Args,'-l', $1)); next arg; };
2971 /^-syslib(.*)/ && do { local($syslib) = &grab_arg_arg(*Args,'-syslib',$1);
2972 &add_syslib($syslib);
2975 #=======================================================================
2976 # various flags that we can harmlessly send to one program or another
2977 # (we will later "reclaim" some of the compiler ones now sent to gcc)
2978 #=======================================================================
2980 #---------- this driver itself (ghc) -----------------------------------
2981 # these change what executable is run for each phase:
2982 /^-pgmL(.*)$/ && do { $Unlit = $1; next arg; };
2983 /^-pgmP(.*)$/ && do { $HsCpp = $1; next arg; };
2984 /^-pgmC(.*)$/ && do { $HsC = $1; next arg; };
2985 /^-pgmcO?(.*)$/ && do { $CcRegd = $1; next arg; }; # the O? for back compat
2986 /^-pgma(.*)$/ && do { $As = $1; next arg; };
2987 /^-pgml(.*)$/ && do { $Lnkr = $1; next arg; };
2988 /^-pgmdep(.*)$/ && do { $MkDependHS = $1; next arg; };
2990 #---------- the get-anything-through opts (all pgms) -------------------
2991 # these allow arbitrary option-strings to go to any phase:
2992 /^-optL(.*)$/ && do { push(@Unlit_flags, $1); next arg; };
2993 /^-optP(.*)$/ && do { push(@HsCpp_flags, $1); next arg; };
2994 /^-optCrts(.*)$/&& do { push(@HsC_rts_flags, $1); next arg; };
2995 /^-optC(.*)$/ && do { push(@HsC_flags, $1); next arg; };
2996 /^-optcpp(.*)$/ && do { push(@Cpp_define, $1); $Only_preprocess_hc = ($1 eq "-E"); next arg; };
2997 /^-optc(.*)$/ && do { push(@CcBoth_flags, $1); next arg; };
2998 /^-opta(.*)$/ && do { push(@As_flags, $1); next arg; };
2999 /^-optl(.*)$/ && do { push(@Ld_flags, $1); next arg; };
3000 /^-optdll(.*)$/ && do { push(@Dll_flags, $1); next arg; };
3001 /^-optdep(.*)$/ && do { push(@MkDependHS_flags, $1); next arg; };
3003 #---------- Haskell C pre-processor (hscpp) ----------------------------
3004 /^-D(.*)/ && do { push(@HsCpp_flags, "'-D".&grab_arg_arg(*Args,'-D',$1)."'"); next arg; };
3005 /^-U(.*)/ && do { push(@HsCpp_flags, "'-U".&grab_arg_arg(*Args,'-U',$1)."'"); next arg; };
3007 #---------- post-Haskell "assembler"------------------------------------
3008 /^-ddump-raw-asm$/ && do { $Dump_raw_asm = 1; next arg; };
3009 /^-ddump-asm-splitting-info$/ && do { $Dump_asm_splitting_info = 1; next arg; };
3011 #---------- Haskell compiler (hsc) -------------------------------------
3013 /^-keep-hc-files?-too$/ && do { $Keep_hc_file_too = 1; next arg; };
3014 /^-keep-s-files?-too$/ && do { $Keep_s_file_too = 1; next arg; };
3016 /^-fignore-interface-pragmas$/ && do { push(@HsC_flags, $_); next arg; };
3017 /^-fignore-asserts$/ && do { push(@HsC_flags, $_); next arg; };
3019 /^-fno-implicit-prelude$/ && do { $NoImplicitPrelude= 1; push(@HsC_flags, $_); next arg; };
3022 # have the compiler proper generate concurrent code,
3023 # really only used when you want to configure your own
3024 # special user compilation way.
3026 # (ditto for -fgransim, fscc-profiling, -fparallel and -fticky-ticky)
3028 /^-fscc-profiling$/ && do { push(@HsC_flags,$_); next arg; };
3029 /^-fticky-ticky$/ && do { push(@HsC_flags,$_); next arg; };
3030 /^-fgransim$/ && do { push(@HsC_flags,$_); next arg; };
3031 /^-fparallel$/ && do { push(@HsC_flags,$_); next arg; };
3033 /^-split-objs$/ && do {
3034 if ( $TargetPlatform !~ /^(alpha|hppa1\.1|i386|m68k|mips|powerpc|rs6000|sparc)-/ ) {
3036 print STDERR "WARNING: don't know how to split objects on this platform: $TargetPlatform\n`-split-objs' option ignored\n";
3041 push(@HsC_flags, "-fglobalise-toplev-names");
3042 push(@CcBoth_flags, '-DUSE_SPLIT_MARKERS');
3044 require('ghc-split.prl')
3045 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-split.prl!\n");
3049 /^-unreg$/ && do { $UNREGing = 'u'; next arg; };
3050 /^-funregisterised$/ && do { push(@HsC_flags, $_); next arg; };
3051 /^-fno-asm-mangling$/ && do { $DoAsmMangling = 0; next arg; };
3053 /^-fallow-overlapping-instances$/ && do { push(@HsC_flags, $_); next arg; };
3054 /^-fallow-undecidable-instances$/ && do { push(@HsC_flags, $_); next arg; };
3055 /^-fhistory-size.*$/ && do { push(@HsC_flags, $_); next arg; };
3056 /^-fdicts-strict$/ && do { push(@HsC_flags, $_); next arg; };
3058 && do { push(@HsC_flags, $_);
3060 # -fglasgow-exts implies -syslib exts
3061 &add_syslib('exts');
3066 && do { $Oopt_DoSpecialise = '-fspecialise'; next arg; };
3067 /^-fno-speciali[sz]e$/
3068 && do { $Oopt_DoSpecialise = ''; next arg; };
3071 && do { $Oopt_UsageSPInf = '-fusagesp';
3072 push (@HsC_flags, '-fusagesp-on'); next arg; };
3074 /^-fcompiling-prelude$/ && do { $CompilingPrelude=1; push(@HsC_flags, $_); next arg; };
3076 # Now the foldr/build options, which are *on* by default (for -O).
3079 && do { $Oopt_FoldrBuild = 1;
3083 /^-fno-foldr-build$/
3084 && do { $Oopt_FoldrBuild = 0;
3087 # --------------- Renamer -------------
3090 /^-fno-prune-tydecls$/ && do { push(@HsC_flags, $_); next arg; };
3091 /^-fno-prune-instdecls$/ && do { push(@HsC_flags, $_); next arg; };
3095 /^-fasm-(.*)$/ && do { $HscOut = '-S='; next arg; }; # force using nativeGen
3096 /^-fvia-[cC]$/ && do { $HscOut = '-C='; next arg; }; # force using C compiler
3101 && do { push(@HsC_flags, $_); next arg };
3103 /^-funfold-casms-in-hi-file$/
3104 && do { push(@HsC_flags, $_); next arg };
3106 /^(-fmax-simplifier-iterations)(.*)$/
3107 && do { $Oopt_MaxSimplifierIterations = $1 . &grab_arg_arg(*Args,$1, $2);
3110 /^-fno-pedantic-bottoms$/
3111 && do { $Oopt_PedanticBottoms = ''; next arg; };
3113 /^-fno-pre-inlining$/
3114 && do { push(@HsC_flags, $_); next arg };
3116 /^-fno-let-from-(case|app|strict-let)$/ # experimental, really (WDP 95/10)
3117 && do { push(@HsC_flags, $_); next arg; };
3119 /^-funbox-strict-fields$/
3120 && do { push(@HsC_flags, $_); next arg; };
3122 # --------------- Warnings etc. ------
3124 /^-fwarn-(.*)$/ && do { push(@HsC_flags, $_); next arg; };
3126 /^-fno-(.*)$/ && do { push(@HsC_antiflags, "-f$1");
3127 &squashHscFlag("-f$1");
3130 /^-W$/ && do { push(@HsC_flags, @MinusWOpts); next arg; };
3131 /^-Wall$/ && do { push(@HsC_flags, @MinusWallOpts); next arg; };
3132 /^(-Wnot|w)$/ && do { foreach (@Hsc_flags) {
3133 /^-fwarn-(.*)$/ && do { $_=''; };
3135 push(@HsC_antiflags, @StandardWarnings);
3138 # --------------- fun stuff ----------------
3140 /^-freport-compile$/ && do { push(@HsC_flags, $_); next arg; };
3142 # --------------- platform specific flags (for gcc mostly) ----------------
3144 /^-mlong-calls$/ && do { # for GCC for HP-PA boxes,
3145 # for 2.6.x..?, does not apply for 2.7.2
3147 unshift(@CcBoth_flags, ( $_ ));
3150 /^-m(v8|sparclite|cypress|supersparc|cpu=(cypress|supersparc))$/
3151 && do { # for GCC for SPARCs
3152 unshift(@CcBoth_flags, ( $_ ));
3155 /^-monly-([432])-regs/ && do { # for iX86 boxes only; no effect otherwise
3156 $StolenX86Regs = $1;
3159 #*************** ... and lots of debugging ones (form: -d* )
3161 # -d(no-)core-lint is done this way so it is turn-off-able.
3162 /^-dcore-lint/ && do { $CoreLint = '-dcore-lint'; next arg; };
3163 /^-dno-core-lint/ && do { $CoreLint = ''; next arg; };
3164 # Ditto for USP lint
3165 /^-dusagesp-lint/ && do { $USPLint = '-dusagesp-lint'; next arg; };
3166 /^-dno-usagesp-lint/ && do { $USPLint = ''; next arg; };
3167 # Ditto for STG lint
3168 /^-dstg-lint/ && do { $StgLint = '-dstg-lint'; next arg; };
3169 /^-dno-stg-lint/ && do { $StgLint = ''; next arg; };
3171 /^-d(dump|ppr)-/ && do { push(@HsC_flags, $_); next arg; };
3172 /^-dverbose-(simpl|stg)/ && do { push(@HsC_flags, $_); next arg; };
3173 /^-dshow-passes/ && do { push(@HsC_flags, $_); next arg; };
3174 /^-dshow-rn-stats/ && do { push(@HsC_flags, $_); next arg; };
3175 /^-dshow-rn-trace/ && do { push(@HsC_flags, $_); next arg; };
3176 /^-dsource-stats/ && do { push(@HsC_flags, $_); next arg; };
3177 /^-dsimplifier-stats/ && do { push(@HsC_flags, $_); next arg; };
3178 /^-dstg-stats/ && do { $Oopt_StgStats = $_; next arg; };
3180 #*************** ... and now all these -R* ones for its runtime system...
3182 /^-Rscale-sizes?(.*)/ && do {
3183 $Scale_sizes_by = &grab_arg_arg(*Args,'-Rscale-sizes', $1);
3186 /^(-H|-Rmax-heapsize)(.*)/ && do {
3187 local($heap_size) = &grab_arg_arg(*Args,$1, $2);
3188 if ($heap_size =~ /(\d+)[Kk]$/) {
3189 $heap_size = $1 * 1000;
3190 } elsif ($heap_size =~ /(\d+)[Mm]$/) {
3191 $heap_size = $1 * 1000 * 1000;
3192 } elsif ($heap_size =~ /(\d+)[Gg]$/) {
3193 $heap_size = $1 * 1000 * 1000 * 1000;
3195 if ($heap_size <= 0) {
3196 print STDERR "$Pgm: resetting heap-size to zero!!! $heap_size\n";
3197 $Specific_heap_size = 0;
3199 # if several heap sizes given, take the largest...
3200 } elsif ($heap_size >= $Specific_heap_size) {
3201 $Specific_heap_size = $heap_size;
3203 print STDERR "$Pgm: ignoring heap-size-setting option ($_)...not the largest seen\n";
3207 /^(-K|Rmax-(stk|stack)size)(.*)/ && do {
3209 local($stk_size) = &grab_arg_arg(*Args,'-Rmax-stksize', $3);
3210 if ($stk_size =~ /(\d+)[Kk]$/) {
3211 $stk_size = $1 * 1000;
3212 } elsif ($stk_size =~ /(\d+)[Mm]$/) {
3213 $stk_size = $1 * 1000 * 1000;
3214 } elsif ($stk_size =~ /(\d+)[Gg]$/) {
3215 $stk_size = $1 * 1000 * 1000 * 1000;
3217 if ($stk_size <= 0) {
3218 print STDERR "$Pgm: resetting stack-size to zero!!! $stk_size\n";
3219 $Specific_stk_size = 0;
3221 # if several stack sizes given, take the largest...
3222 } elsif ($stk_size >= $Specific_stk_size) {
3223 $Specific_stk_size = $stk_size;
3225 print STDERR "$Pgm: ignoring stack-size-setting option ($flag $stk_size)...not the largest seen\n";
3229 /^-Rgc-stats$/ && do { $CollectingGCstats++;
3230 # the two RTSs do this diff ways; we will try to compensate
3233 /^-Rghc-timing/ && do { $CollectGhcTimings = 1; next arg; };
3235 #---------- C high-level assembler (gcc) -------------------------------
3236 /^-(Wall|ansi|pedantic)$/ && do { push(@CcBoth_flags, $_); next arg; };
3238 # -dgcc-lint is a useful way of making GCC very fussy.
3239 # From alan@spri.levels.unisa.edu.au (Alan Modra).
3240 /^-dgcc-lint$/ && do { push(@CcBoth_flags, '-Wall -Wpointer-arith -Wbad-function-cast -Wcast-qual -Wstrict-prototypes -Wmissing-prototypes -Wmissing-declarations -Wnested-externs'); next arg; };
3241 # An alternate set, from mark@sgcs.com (Mark W. Snitily)
3242 # -Wall -Wstrict-prototypes -Wmissing-prototypes -Wcast-align -Wshadow
3244 # inject "#include <wurble>" into the compiler's C output!
3246 /^-#include(.*)/ && do {
3247 local($to_include) = &grab_arg_arg(*Args,'-#include', $1);
3248 push(@CcInjects, "#include $to_include\n");
3251 #---------- Linker (gcc, really) ---------------------------------------
3253 /^-static$/ && do { $Static=1; push(@Ld_flags, $_); next arg; };
3254 /^-no-hs-main$/ && do { $NoHaskellMain=1; next arg; };
3256 #---------- mixed cc and linker magic ----------------------------------
3257 # this optimisation stuff is finally sorted out later on...
3259 /^-O2-for-C$/ && do { $MinusO2ForC = 1; next arg; };
3261 /^-O[1-2]?$/ && do {
3262 local($opt_lev) = ( /^-O2$/ ) ? 2 : 1; # max 'em
3263 $OptLevel = ( $opt_lev > $OptLevel ) ? $opt_lev : $OptLevel;
3265 $HscOut = '-C=' if $OptLevel == 2; # force use of C compiler
3268 /^-Onot$/ && do { $OptLevel = 0; next arg; }; # # set it to <no opt>
3270 /^-Ofile(.*)/ && do {
3272 local($ofile) = &grab_arg_arg(*Args,'-Ofile', $1);
3273 @HsC_minusO3_flags = ();
3275 open(OFILE, "< $ofile") || die "Can't open $ofile!\n";
3278 s/\#.*//; # death to comments
3279 s/[ \t]+//g; # death to whitespace
3280 next if /^$/; # ditto, blank lines
3281 s/([()*{}])/\\$1/g; # protect shell metacharacters
3283 push(@CcBoth_flags, $1);
3285 push(@HsC_minusO3_flags, $_);
3291 /^-debug$/ && do { # all this does is mark a .hc/.o as "debugging"
3292 # in the consistency info
3296 #---------- linking .a file --------------------------------------------
3298 /^-Main(.*)/ && do {
3299 # specifies main or mainPrimIO to be linked
3303 #---------- catch unrecognized flags -----------------------------------
3306 print STDERR "$Pgm: unrecognised option: $_\n";
3312 } # end of processArgs