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_*_HC_OPTS
125 Establish what executables to run for the various phases, what the
126 default options are for those phases, and other similar boring stuff.
129 select(STDERR); $| = 1; select(STDOUT); # no STDERR buffering, please.
131 $TargetPlatform = $TARGETPLATFORM;
133 $TopPwd = "${TOP_PWD}";
134 $InstBinDirGhc = "${bindir}";
135 $InstLibDirGhc = "${libdir}";
137 # Normally the same as InstLibDirGhc, but we accommodate
138 # for it being separate.
140 $InstLibExecDirGhc = "${libexecdir}";
141 $InstDataDirGhc = "${datadir}";
143 $Status = 0; # just used for exit() status
146 # set up signal handler
147 sub quit_upon_signal { &tidy_up_and_die(1, ''); }
148 $SIG{'INT'} = 'quit_upon_signal';
149 $SIG{'QUIT'} = 'quit_upon_signal';
151 # where to get "require"d .prl files at runtime (poor man's dynamic loading)
152 # (use LIB, not DATA, because we can't be sure of arch-independence)
153 @INC = ( ( $INSTALLING ) ? $InstLibDirGhc
154 : "$TopPwd/${CURRENT_DIR}" );
156 if ( $ENV{'TMPDIR'} ) { # where to make tmp file names
157 $Tmp_prefix = ($ENV{'TMPDIR'} . "/ghc$$");
159 print STDERR "TMPDIR has not been set to anything useful!\n" if (${TMPDIR} eq '');
160 $Tmp_prefix ="${TMPDIR}/ghc$$"; # TMPDIR set via Makefile when booting..
161 $ENV{'TMPDIR'} = ${TMPDIR}; # set the env var as well
164 # Some shells run into real trouble when command line and environment
165 # gets big (e.g., cmd lines of >4K to /bin/sh causes havoc on our
166 # Solaris-2.5.1 boxes - even though sysconf(_SC_ARG_MAX) reports 1M ...).
167 # To work around any such */bin/sh* problems, we will scribble such
168 # awfully long command lines into a temp file and exec that temp file
169 # with $(REAL_SHELL) (don't use the SHELL variable directly as this
170 # will normally get you the wrong thing when the driver is invoked
171 # from within `make'). If the REAL_SHELL variable isn't set, you'll
172 # get SHELL. This is all a terrible hack. (in case you hadn't reached
173 # the same conclusion by now :-)
177 if ( ! $ENV{'REAL_SHELL'} ) {
178 $ENV{'REAL_SHELL'} = $ENV{'SHELL'};
181 @Files_to_tidy = (); # files we nuke in the case of abnormal termination
183 $Unlit = ( $INSTALLING ) ? "$InstLibExecDirGhc/unlit"
184 : "$TopPwd/${CURRENT_DIR}/${GHC_UNLIT}";
188 $Diff = $CONTEXT_DIFF;
193 $HsCpp = # but this is re-set to "cat" (after options) if -cpp not seen
194 ( $INSTALLING ) ? "$InstLibExecDirGhc/hscpp"
195 : "$TopPwd/${CURRENT_DIR}/${GHC_HSCPP}";
198 $HsC = ( $INSTALLING ) ? "$InstLibExecDirGhc/hsc"
199 : "$TopPwd/${CURRENT_DIR}/${GHC_HSC}";
201 # For PVM fiends only
202 $SysMan = ( $INSTALLING ) ? "$InstLibExecDirGhc/SysMan"
203 : "$TopPwd/${CURRENT_DIR}/${GHC_SYSMAN}";
208 # HsC_rts_flags: if we want to talk to the LML runtime system
209 # NB: we don't use powers-of-2 sizes, because this may do
210 # terrible things to cache behavior.
212 $Specific_heap_size = 6 * 1000 * 1000;
213 $Specific_stk_size = 1000 * 1000;
214 $Scale_sizes_by = 1.0;
218 The variables set by @setupOptFlags@ represent parts of the
219 -O/-O2/etc ``templates,'' which are filled in later, using these.
220 These are the default values, which may be changed by user flags.
224 $Oopt_MaxSimplifierIterations = '-fmax-simplifier-iterations4';
225 $Oopt_PedanticBottoms = '-fpedantic-bottoms'; # ON by default
226 $Oopt_MonadEtaExpansion = '';
227 $Oopt_FinalStgProfilingMassage = '';
229 $Oopt_DoSpecialise = '-fspecialise';
230 $Oopt_FoldrBuild = 0; # *Off* by default!
231 $Oopt_FB_Support = ''; # was '-fdo-arity-expand';
232 # $Oopt_FoldrBuildWW = 0; # Off by default
233 $Oopt_FoldrBuildInline = ''; # was '-fdo-inline-foldr-build';
234 $Oopt_ShowSimplifierProgress = '';
235 } # end of setupOptFlags
237 # Assign defaults to these right away.
241 Things to do with C compilers/etc:
243 (added -Wimplicit: implicit prototypes cause very hard-to-find
244 problems, so I'm turing on the warnings -- SDM 4/5/98)
247 $CcRegd = $GHC_OPT_HILEV_ASM;
248 @CcBoth_flags = ('-S','-Wimplicit'); # flags for *any* C compilation
252 # those for all files,
253 # those only for .c files;
254 # those only for .hc files
257 @CcRegd_flags_c = ();
258 @CcRegd_flags_hc = ();
260 $As = ''; # "assembler" is normally GCC
263 $Lnkr = ''; # "linker" is normally GCC
266 # 'nm' is used for consistency checking (ToDo: mk-world-ify)
267 # ToDo: check the OS or something ("alpha" is surely not the crucial question)
268 $Nm = ($TargetPlatform =~ /^alpha-/) ? 'nm -B' : 'nm';
271 Warning packages that are controlled by -W and -Wall. The 'standard'
272 warnings that you get all the time are
274 -fwarn-overlapping-patterns
275 -fwarn-missing-methods
276 -fwarn-duplicate-exports
278 these are turned off by -Wnot.
281 @StandardWarnings = ('-fwarn-overlapping-patterns',
282 '-fwarn-missing-methods',
283 '-fwarn-duplicate-exports');
284 @MinusWOpts = (@StandardWarnings,
285 '-fwarn-incomplete-patterns',
286 '-fwarn-unused-binds',
287 '-fwarn-unused-imports');
288 @MinusWallOpts = (@MinusWOpts,
289 '-fwarn-unused-matches',
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',
306 '_mp', "$WAY_mp_NAME",
307 '_mg', "$WAY_mg_NAME",
325 '_B', "$WAY_B_NAME" );
327 # these are options that are "fed back" through the option processing loop
331 '_a', "$WAY_a_HC_OPTS",
332 '_b', "$WAY_b_HC_OPTS",
333 '_c', "$WAY_c_HC_OPTS",
334 '_d', "$WAY_d_HC_OPTS",
335 '_e', "$WAY_e_HC_OPTS",
336 '_f', "$WAY_f_HC_OPTS",
337 '_g', "$WAY_g_HC_OPTS",
338 '_h', "$WAY_h_HC_OPTS",
339 '_i', "$WAY_i_HC_OPTS",
340 '_j', "$WAY_j_HC_OPTS",
341 '_k', "$WAY_k_HC_OPTS",
342 '_l', "$WAY_l_HC_OPTS",
343 '_m', "$WAY_m_HC_OPTS",
344 '_n', "$WAY_n_HC_OPTS",
345 '_o', "$WAY_o_HC_OPTS",
346 '_A', "$WAY_A_HC_OPTS",
347 '_B', "$WAY_B_HC_OPTS",
350 '_p', "$WAY_p_HC_OPTS",
351 '_t', "$WAY_t_HC_OPTS",
352 '_u', "$WAY_u_HC_OPTS",
353 '_mp', "$WAY_mp_HC_OPTS",
354 '_mg', "$WAY_mg_HC_OPTS");
358 Import/include directories (\tr{-I} options) are sufficiently weird to
359 require special handling.
362 @Import_dir = ('.'); #-i things
363 @Include_dir = ('.'); #-I things; other default(s) stuck on AFTER option processing
365 # where to look for interface files (system hi's, i.e., prelude and syslibs)
366 @SysImport_dir = ( $INSTALLING )
367 ? ( "$InstLibDirGhc/imports/std" )
368 : ( "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/std" );
370 # We need to look in ghc/ and glaExts/ when searching for implicitly needed .hi files, but
371 # we should really *not* look there for explicitly imported modules.
373 $Haskell1Version = 4; # i.e., Haskell 1.4
376 # Cpp symbols defined when we're processing Haskell source.
379 ( "-D__HASKELL1__=$Haskell1Version"
380 , "-D__GLASGOW_HASKELL__=$ProjectVersionInt"
382 # , "-D__CONCURRENT_HASKELL__"
385 @UserLibrary_dir= (); #-L things;...
386 @UserLibrary = (); #-l things asked for by the user
388 @SysLibrary_dir = ( ( $INSTALLING ) #-syslib things supplied by the system
390 : ( "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR"
391 , "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR/gmp"
392 , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/std"
393 , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/std/cbits"
396 @SysLibrary = (); # will be built up as we go along
398 $TopClosureFile # defaults to 1.2 one; will be mangled later
400 # ( $INSTALLING) ? "$InstLibDirGhc/TopClosureXXXX.o"
401 # : "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR/main/TopClosureXXXX.o";
403 # make depend for Haskell
405 = ( $INSTALLING ) ? "$InstBinDirGhc/mkdependHS"
406 : "$TopPwd/$CURRENT_DIR/$GHC_UTILS_DIR/mkdependHS/mkdependHS";
408 @MkDependHS_flags = ();
410 # do_link flag should not be reset while rescanning the cmd-line.
412 $Specific_output_dir = ''; # set by -odir <dir>
413 $Specific_output_file = ''; # set by -o <file>; "-" for stdout
416 Function to initialise the per-compilation-unit globals that
417 are used to guide and control the invocation of the different phases.
420 sub initDriverGlobals {
422 # reset the following options:
423 # RTS flags to use while compiling
425 @HsP_flags = (); # these are the flags destined solely for
426 # the flex/yacc parser
431 The optimisations/etc to be done by the compiler are {\em normally}
432 expressed with a \tr{-O} (or \tr{-O2}) flag, or by its absence.
435 $OptLevel = 0; # no -O == 0; -O == 1; -O2 == 2; -Ofile == 3
436 $MinusO2ForC = 0; # set to 1 if -O2 should be given to C compiler
437 $StolenX86Regs = 4; # **HACK*** of the very worst sort
441 @Import_dir = ('.'); #-i things
442 @Include_dir = ('.'); #-I things; other default(s) stuck on AFTER option processing
447 We are given a list of files with various presumably-known suffixes
448 (unknown-suffix files go straight to the linker). For each file, we
449 begin by assuming that we'll run every phase over it. However: (1)
450 global flags (\tr{-c}, \tr{-S}, etc.) tell us not to run any phase
451 past a certain point; and (2) the file's suffix tells us what phase to
452 start with. Linking is weird and kept track of separately.
454 Here are the initial defaults applied to all files:
456 $Cpp_flag_set = 0; # (hack)
457 $Only_preprocess_C = 0; # pretty hackish
458 $Only_preprocess_hc = 0; # ditto
459 $Only_generate_deps = 0; # "
460 $PostprocessCcOutput = 0;
462 # native code-gen or via C?
463 $HaveNativeCodeGen = $GhcWithNativeCodeGen;
464 $HscOut = '-C='; # '-C=' ==> .hc output; '-S=' ==> .s output; '-N=' ==> neither
466 if $HaveNativeCodeGen && $TargetPlatform =~ /^(alpha)-/;
467 # TEMP: disable x86 & Sparc if $HaveNativeCodeGen && $TargetPlatform =~ /^(i386|alpha|sparc)-/;
468 $ProduceHi = '-hifile=';
474 $CollectingGCstats = 0;
475 $CollectGhcTimings = 0;
476 $DEBUGging = ''; # -DDEBUG and all that it entails (um... not really)
477 $PROFing = ''; # set to p or e if profiling
478 $PROFgroup = ''; # set to group if an explicit -Ggroup specified
479 $PROFauto = ''; # set to relevant hsc flag if -auto or -auto-all
480 $PROFcaf = ''; # set to relevant hsc flag if -caf-all
481 $PROFignore_scc = ''; # set to relevant parser flag if explicit sccs ignored
482 $UNPROFscc_auto = ''; # set to relevant hsc flag if forcing auto sccs without profiling
483 $TICKYing = ''; # set to t if compiling for ticky-ticky profiling
484 $PARing = ''; # set to p if compiling for PAR
485 $GRANing = ''; # set to g if compiling for GRAN
486 $Specific_hi_file = ''; # set by -ohi <file>; "-" for stdout
487 $Specific_dump_file = ''; # set by -odump <file>; "-" for stdout
488 $Using_dump_file = 0;
490 $Osuffix = ''; # default: use the normal suffix for that kind of output
492 $HiSuffix_prelude = '';
493 $Do_recomp_chkr = 0; # don't use the recompilatio checker unless asked
494 $Do_cc = -1; # a MAGIC indeterminate value; will be set to 1 or 0.
497 $Keep_hc_file_too = 0;
498 $Keep_s_file_too = 0;
499 $UseGhcInternals = 0; # if 1, may use GHC* modules
501 $DoAsmMangling = 1; # on by default, off by -fno-asm-mangling
503 $Dump_parser_output = 0;
505 $Dump_asm_splitting_info = 0;
506 $NoImplicitPrelude = 0;
507 # 1 => don't tell the linker to hoist in PrelMain.Main, as an
508 # external main is provided instead.
511 } # end of initDriverGlobals (Sigh)
513 # we split the argv passed to the driver into three:
518 # and files to be linked...
524 # cmd line options prefixing the unit we're compiling
529 We inject consistency-checking information into \tr{.hc} files (both
530 when created by the Haskell compiler and when compiled by the C
531 compiler), so that we can check that an executable is made from
532 consistently-built pieces. (The check is normally done just after
533 linking.) The checking is done by introducing/munging
534 \tr{what(1)}-style strings. Anyway, here are the relevant global
535 variables and their defaults:
537 $LinkChk = 0; # set to 0 if the link check should *not* be done
539 # major & minor version numbers; major numbers must always agree;
540 # minor disagreements yield a warning.
541 $HsC_major_version = $HscMajorVersion;
542 $HsC_minor_version = $HscMinorVersion;
543 $Cc_major_version = $CcMajorVersion;
544 $Cc_minor_version = $CcMinorVersion;
546 # options: these must always agree
547 $HsC_consist_options = ''; # we record, in this order:
548 # Build tag; debugging?
549 $Cc_consist_options = ''; # we record, in this order:
550 # Build tag; debugging?
553 %************************************************************************
555 \section[Driver-parse-argv]{Munge the command-line options}
557 %************************************************************************
559 Now slurp through the arguments.
562 &initDriverGlobals();
563 &splitCmdLine(@ARGV);
564 # Run through the cmd-line first time.
565 &processArgs(@Cmd_opts);
567 # Check to see if driver is only in the business
568 # to generate dependencies
569 if ( $Status == 0 && $Only_generate_deps ) {
571 push (@MkDependHS_flags, "-o$Osuffix") if $Osuffix;
572 push (@MkDependHS_flags, "-s$BuildTag") if $BuildTag;
573 # They're not (currently) needed, but we need to quote any -#include options
574 foreach (@Cmd_opts) {
575 s/-#include.*$/'$&'/g;
577 local($to_do) = "$MkDependHS @MkDependHS_flags @HsSourceCppOpts -- @Cmd_opts -- @Input_file" ;
578 &run_something($to_do, 'Haskell dependencies');
582 # if there are several input files,
583 # we don't allow \tr{-o <file>} or \tr{-ohi <file>} options...
584 # (except if linking, of course)
586 if ($#Input_file > 0 && ( ! $Do_lnkr )) {
587 if ( ($Specific_output_file ne '' && $Specific_output_file ne '-')
588 || ($Specific_hi_file ne '' && $Specific_hi_file ne '-') ) {
589 print STDERR "$Pgm: You can't use -o or -ohi options if you have multiple input files.\n";
590 print STDERR "\tPerhaps the -odir option will do what you want.\n";
595 # check for various pathological -o and -odir combinations...
596 if ($Specific_output_dir ne '' && $Specific_output_file ne '') {
597 if ($Specific_output_file eq '-') {
598 print STDERR "$Pgm: can't set output directory with -ohi AND have output to stdout\n";
600 } else { # amalgamate...
601 $Specific_output_file = "$Specific_output_dir/$Specific_output_file";
602 # ToDo: check we haven't got a junk name now...
603 $Specific_output_dir = ''; # reset
607 # crash and burn if there were errors
609 print STDERR $ShortUsage;
614 %************************************************************************
616 \section[Driver-post-argv-mangling]{Setup after reading options}
618 %************************************************************************
620 %************************************************************************
622 \subsection{Set up for optimisation level (\tr{-O} or whatever)}
624 %************************************************************************
626 We come now to the default ``wads of options'' that are turned on by
627 \tr{-O0} (do min optimisation), \tr{-O} (ordinary optimisation),
628 \tr{-O2} (aggressive optimisation), or no O-ish flag (compile speed is
631 The user can also specify his/her own list of options in a file; in
632 that case, the work is already done (see stuff about @minusO3@,
635 GHC allows very precise control of what happens during a compilation.
636 Core-to-Core and STG-to-STG passes can be run in any order, as many
637 times as you like. Individual transformations can be turned on or
640 Sadly, however, there are some interdependencies \& Things You Must
641 Not Do. Here is the list.
645 \item[\tr{-fspecialise}:]
646 The specialiser must have dependency-analysed input; but if you run
647 the simplifier to do this, you must not let it toss away unused
648 bindings! (The typechecker conveys some specialisation info via
649 ``unused'' bindings...)
651 \item[\tr{-ffloat-inwards}:]
652 Floating inwards should be done before strictness analysis, because
653 the latter will give better results.
655 \item[\tr{-fstatic-args}:]
656 The static-arguments-transformation pass {\em must} have the
657 simplifier run right after it.
659 \item[\tr{-fcalc-inlinings[12]}:]
660 Not required, but there may be slight gains by re-simplifying after
661 this is done. (You could then \tr{-fcalc-inlinings} again, just for
664 \item[\tr{-ffull-laziness}:]
665 The (outwards-)let-floater should be the {\em last} Core-to-Core pass
666 that's run. (Um, well, howzabout the simplifier just once more...)
671 \item[\tr{-fupdate-analysis}:]
672 It really really wants to be the last STG-to-STG pass that is run.
677 sub setupOptimiseFlags {
683 '-ffloat-lets-exposing-whnf',
684 '-ffloat-primops-ok',
687 # '-fdo-lambda-eta-expansion', # too complicated
689 # '-flet-to-case', # no strictness analysis, so...
690 $Oopt_PedanticBottoms,
691 # $Oopt_MonadEtaExpansion, # no thanks
693 # These two work fine, if you really want no simplification at all,
694 # for bizarre test reasons. But you get really terrible code if you use them,
695 # for example: let x = e in x
696 # with dozens of redundant thunks etc. So I'm leaving them out.
698 # '-fsimpl-uf-use-threshold0',
699 # '-fessential-unfoldings-only',
702 # The presence of -fclone-binds is *temporary* to work around
703 # the fact that the desugarer in 3.0{2.3} does generate
704 # bindings with identical ids, and the type checker doesn't perform
705 # properly cloned type substitutions. Instead, we make sure that all
706 # binders are cloned first time through the simplifier.
708 # Will be properly fixed in the `new compiler` I hear, at which point
709 # the cloning can be turned off here.
714 $Oopt_MaxSimplifierIterations,
715 $Oopt_ShowSimplifierProgress,
718 # '-ffull-laziness', # removed 95/04 WDP following Andr\'e's lead
720 $Oopt_FinalStgProfilingMassage
723 @HsC_minusO_flags # NOTE: used for *both* -O and -O2 (some conditional bits)
725 '-fdo-eta-reduction',
727 # initial simplify: mk specialiser happy: minimum effort please
731 '-fkeep-spec-pragma-ids', # required before specialisation
733 # I don't understand why we want -fessential-unfoldings-only here
734 # If we have it, the following nasty thing happens:
738 # where "*" means exported.
739 # In the essential-unfoldings pass we still substitute f for g
740 # but we don't substitute E for f first. So we get
744 # The g=f will get reverse-substituted later, but it's untidy. --SLPJ
746 # SDM: Here's why it's necessary.
748 # If we unfold in the first pass before the specialiser is run
749 # we miss opportunities for specialisation because eg. wrappers
750 # have been inlined for specialisable functions.
752 # This shows up in PrelArr.lhs - the specialised instance for newArray
753 # calls the generic rangeSize, because rangeSize is strict and is
754 # replaced by its wrapper by the simplifier.
756 '-fessential-unfoldings-only',
757 '-fsimpl-uf-use-threshold0',
759 # See remark re: cloning in defn of minusnotO
762 '-fmax-simplifier-iterations1',
763 $Oopt_PedanticBottoms,
766 ($Oopt_DoSpecialise) ? (
770 '-fsimplify', # need dependency anal after specialiser ...
771 '[', # need tossing before calc-inlinings ...
773 '-ffloat-lets-exposing-whnf',
774 '-ffloat-primops-ok',
778 # '-fdo-eta-reduction',
779 '-fdo-lambda-eta-expansion',
781 $Oopt_PedanticBottoms,
782 $Oopt_MonadEtaExpansion,
783 $Oopt_MaxSimplifierIterations,
784 $Oopt_ShowSimplifierProgress,
786 # The presence of -fclone-binds is *crucial* here as
787 # -ffull-laziness (which we're about to do next) floats
788 # bindings outwards, so we better make sure that this
789 # doesn't result in the floating out of bindings
790 # with identical uniques, i.e., -ffull-laziness needs
791 # to be preceeded by a simplifier pass with -fclone-binds
796 # ($Oopt_FoldrBuildWW) ? (
797 # '-ffoldr-build-ww-anal',
798 # '-ffoldr-build-worker-wrapper',
802 # '-ffloat-lets-exposing-whnf',
803 # '-ffloat-primops-ok',
807 # '-fdo-eta-reduction',
808 # '-fdo-lambda-eta-expansion',
810 # $Oopt_PedanticBottoms,
811 # $Oopt_MonadEtaExpansion,
812 # $Oopt_MaxSimplifierIterations,
813 # $Oopt_ShowSimplifierProgress,
817 # this pass-ordering sequence was agreed by Simon and Andr\'e
818 # (WDP 94/07, 94/11).
821 ($Oopt_FoldrBuild) ? (
822 '-ffoldr-build-on', # desugar list comprehensions for foldr/build
826 '-fignore-inline-pragma', # **** NB!
827 '-fdo-foldr-build', # NB
829 '-ffloat-lets-exposing-whnf',
830 '-ffloat-primops-ok',
834 # '-fdo-eta-reduction',
835 '-fdo-lambda-eta-expansion', # After full laziness
837 $Oopt_PedanticBottoms,
838 $Oopt_MonadEtaExpansion,
839 $Oopt_MaxSimplifierIterations,
840 $Oopt_ShowSimplifierProgress,
849 '-ffloat-lets-exposing-whnf',
850 '-ffloat-primops-ok',
854 '-fdo-eta-reduction',
855 '-fdo-lambda-eta-expansion',
857 ($Oopt_FoldrBuildInline),
858 # you need to inline foldr and build
859 ($Oopt_FoldrBuild) ? ('-fdo-foldr-build') : (),
860 # but do reductions if you see them!
861 $Oopt_PedanticBottoms,
862 $Oopt_MonadEtaExpansion,
863 $Oopt_MaxSimplifierIterations,
864 $Oopt_ShowSimplifierProgress,
872 '-ffloat-lets-exposing-whnf',
873 '-ffloat-primops-ok',
877 # '-fdo-eta-reduction',
878 '-fdo-lambda-eta-expansion',
880 '-flet-to-case', # Aha! Only done after strictness analysis
881 $Oopt_PedanticBottoms,
882 $Oopt_MonadEtaExpansion,
883 $Oopt_MaxSimplifierIterations,
884 $Oopt_ShowSimplifierProgress,
889 # Case-liberation for -O2. This should be after
890 # strictness analysis and the simplification which follows it.
894 # : "-fliberate-case -fsimplify [ $Oopt_FB_Support -ffloat-lets-exposing-whnf -ffloat-primops-ok -fcase-of-case -fdo-case-elim -fcase-merge -fdo-eta-reduction -fdo-lambda-eta-expansion -freuse-con -flet-to-case $Oopt_PedanticBottoms $Oopt_MonadEtaExpansion $Oopt_MaxSimplifierIterations $Oopt_ShowSimplifierProgress ]" ),
896 # Final clean-up simplification:
901 '-ffloat-lets-exposing-whnf',
902 '-ffloat-primops-ok',
906 # '-fdo-eta-reduction',
907 '-fdo-lambda-eta-expansion',
910 '-fignore-inline-pragma', # **** NB!
911 $Oopt_FoldrBuildInline,
912 ($Oopt_FoldrBuild) ? ('-fdo-foldr-build') : (),
913 # but still do reductions if you see them!
914 $Oopt_PedanticBottoms,
915 $Oopt_MonadEtaExpansion,
916 $Oopt_MaxSimplifierIterations,
917 $Oopt_ShowSimplifierProgress,
922 #LATER: '-fcalc-inlinings2', -- pointless for 2.01
926 $Oopt_FinalStgProfilingMassage,
932 # SPECIAL FLAGS for -O2
934 '-fupdate-analysis', # virtually useless; relegated to -O2
941 Sort out what we're going to do about optimising. First, the @hsc@
942 flags and regular @cc@ flags to worry about:
944 if ( $OptLevel <= 0 ) {
946 # for this level, we tell the parser -fignore-interface-pragmas
947 push(@HsC_flags, '-fignore-interface-pragmas');
948 # and tell the compiler not to produce them
949 push(@HsC_flags, '-fomit-interface-pragmas');
951 &add_Hsc_flags( @HsC_minusNoO_flags );
952 push(@CcBoth_flags, ($MinusO2ForC) ? '-O2' : '-O'); # not optional!
954 } elsif ( $OptLevel == 1 || $OptLevel == 2 ) {
956 &add_Hsc_flags( @HsC_minusO_flags );
957 push(@CcBoth_flags, ($MinusO2ForC || $OptLevel == 2) ? '-O2' : '-O'); # not optional!
958 # -O? to GCC is not optional! -O2 probably isn't worth it generally,
959 # but it *is* useful in compiling the garbage collectors (so said
960 # Patrick many moons ago...).
962 } else { # -Ofile, then...
964 &add_Hsc_flags( @HsC_minusO3_flags );
965 push(@HsC_flags, $Oopt_FinalStgProfilingMassage) if $Oopt_FinalStgProfilingMassage;
967 push(@CcBoth_flags, ($MinusO2ForC) ? '-O2' : '-O'); # possibly to be elaborated...
970 } # setupOptimiseFlags
974 %************************************************************************
976 \subsection{Check for consistency, etc.}
978 %************************************************************************
980 Sort out @$BuildTag@, @$PROFing@, @$PARing@,
981 @$GRANing@, @$TICKYing@:
983 sub setupBuildFlags {
986 # PROFILING stuff after argv mangling:
988 # warn about any scc exprs found (in case scc used as identifier)
989 push(@HsP_flags, '-W');
991 # add -auto sccs even if not profiling !
992 push(@HsC_flags, $UNPROFscc_auto) if $UNPROFscc_auto;
995 push(@HsC_flags, $PROFauto) if $PROFauto;
996 push(@HsC_flags, $PROFcaf) if $PROFcaf;
997 #push(@HsC_flags, $PROFdict) if $PROFdict;
999 $Oopt_FinalStgProfilingMassage = '-fmassage-stg-for-profiling';
1001 # Ignore user sccs when auto annotating, but warn when doing so.
1002 $PROFignore_scc = '-W' if $PROFauto;
1004 push(@HsP_flags, (($PROFignore_scc) ? $PROFignore_scc : '-S'));
1006 #if ( $BuildTag ne '' ) {
1007 # local($b) = $BuildDescr{$BuildTag};
1008 # if ($PARing eq 'p') { print STDERR "$Pgm: Can't mix $b with -parallel.\n"; exit 1; }
1009 # if ($GRANing eq 'g') { print STDERR "$Pgm: Can't mix $b with -gransim.\n"; exit 1; }
1010 # if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix $b with -ticky.\n"; exit 1; }
1012 # # ok to have a user-way profiling build
1013 # # eval the profiling opts ... but leave user-way BuildTag
1014 # if ($PROFing eq 'p') { &processArgs(split(' ', $SetupOpts{'_p'})); } # eval($EvaldSetupOpts{'_p'}); }
1016 if ( $PROFing eq 'p' ) {
1017 if ($PARing eq 'p') { print STDERR "$Pgm: Can't do profiling with -parallel.\n"; exit 1; }
1018 if ($GRANing eq 'g') { print STDERR "$Pgm: Can't do profiling with -gransim.\n"; exit 1; }
1019 if ($TICKYing eq 't') { print STDERR "$Pgm: Can't do profiling with -ticky.\n"; exit 1; }
1022 } elsif ( $PARing eq 'p' ) {
1023 if ($GRANing eq 'g') { print STDERR "$Pgm: Can't mix -parallel with -gransim.\n"; exit 1; }
1024 if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix -parallel with -ticky.\n"; exit 1; }
1027 if ( $Do_lnkr && ( ! $ENV{'PVM_ROOT'} || ! $ENV{'PVM_ARCH'} )) {
1028 print STDERR "$Pgm: both your PVM_ROOT and PVM_ARCH environment variables must be set for linking under -parallel.\n";
1032 } elsif ( $GRANing eq 'g' ) {
1033 if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix -gransim with -ticky.\n"; exit 1; }
1036 } elsif ( $TICKYing eq 't' ) {
1042 After the sanity checks, add flags to the necessary parts of the driver pipeline:
1045 if ( $BuildTag ne '' ) { # something other than normal sequential...
1047 local($Tag) = "${BuildTag}";
1048 $Tag =~ s/_//; # move the underscore to the back
1050 $HscOut = '-C='; # must go via C
1051 &processArgs(split(' ', $SetupOpts{$BuildTag}));
1052 # eval($EvaldSetupOpts{$BuildTag});
1056 Decide what the consistency-checking options are in force for this run:
1059 $HsC_consist_options = "${BuildTag},${DEBUGging}";
1060 $Cc_consist_options = "${BuildTag},${DEBUGging}";
1063 # Funny place to put it, but why not.
1065 if ( $HiSuffix_prelude eq '' ) {
1066 local($Tag) = "${BuildTag}";
1068 $Tag = "${Tag}_" if $Tag ne '';
1069 $HiSuffix_prelude="${Tag}hi";
1074 %************************************************************************
1076 \subsection{Add on machine-specific C-compiler flags}
1078 %************************************************************************
1080 Shove on magical machine-specific options. We use \tr{unshift} to
1081 stick them on the {\em front} of the arrays, so that ``later''
1082 user-specified flags can clobber them (e.g., \tr{-U__STG_REV_TBLS__}).
1084 Note: a few ``always apply'' flags were set at the very beginning.
1089 if ($TargetPlatform =~ /^alpha-/) {
1090 unshift(@CcBoth_flags, ('-static'));
1092 } elsif ($TargetPlatform =~ /^hppa/) {
1093 unshift(@CcBoth_flags, ('-static'));
1095 # We don't put in '-mlong-calls', because it's only
1096 # needed for very big modules (sigh), and we don't want
1097 # to hobble ourselves further on all the other modules
1100 # [Dated comment (gcc-2.6.x?), -mlong-calls is no longer
1101 # a supported gcc HPPA flag]
1102 unshift(@CcBoth_flags, ('-D_HPUX_SOURCE'));
1103 # ___HPUX_SOURCE, not _HPUX_SOURCE, is #defined if -ansi!
1104 # (very nice, but too bad the HP /usr/include files don't agree.)
1106 } elsif ($TargetPlatform =~ /^i386-/) {
1107 # -fno-defer-pop : basically the same game as for m68k
1109 # -fomit-frame-pointer : *must* ; because we're stealing
1110 # the fp (%ebp) for our register maps. *All* register
1111 # maps (in MachRegs.lh) must steal it.
1113 unshift(@CcRegd_flags_hc, '-fno-defer-pop');
1114 unshift(@CcRegd_flags, '-fomit-frame-pointer');
1115 unshift(@CcRegd_flags, "-DSTOLEN_X86_REGS=$StolenX86Regs");
1117 } elsif ($TargetPlatform =~ /^m68k-/) {
1118 # -fno-defer-pop : for the .hc files, we want all the pushing/
1119 # popping of args to routines to be explicit; if we let things
1120 # be deferred 'til after an STGJUMP, imminent death is certain!
1122 # -fomit-frame-pointer : *don't*
1123 # It's better to have a6 completely tied up being a frame pointer
1124 # rather than let GCC pick random things to do with it.
1125 # (If we want to steal a6, then we would try to do things
1126 # as on iX86, where we *do* steal the frame pointer [%ebp].)
1128 unshift(@CcRegd_flags_hc, '-fno-defer-pop');
1129 unshift(@CcRegd_flags, '-fno-omit-frame-pointer');
1130 # maybe gives reg alloc a better time
1131 # also: -fno-defer-pop is not sufficiently well-behaved without it
1133 } elsif ($TargetPlatform =~ /^mips-/) {
1134 unshift(@CcBoth_flags, ('-static'));
1136 } elsif ($TargetPlatform =~ /^powerpc-|^rs6000-/) {
1137 unshift(@CcBoth_flags, ('-static')); # always easier to start with
1138 unshift(@CcRegd_flags, ('-finhibit-size-directive')); # avoids traceback tables
1139 } elsif ($TargetPlatform =~ /^sparc-/) {
1141 } # end of setupMachOpts
1144 %************************************************************************
1146 \subsection{Set up for warnings}
1148 %************************************************************************
1150 Several warnings are turned on by default. These are supposed to be
1151 the 'I'm pretty sure you've made a mistake here' kind of warnings.
1152 The rest are turned on by the -W and -Wall options, or individually
1153 via their -fwarn and -fno-warn flags.
1156 sub setupWarningFlags {
1157 &add_Hsc_flags( @StandardWarnings );
1161 Same unshifting magic, but for special linker flags.
1163 The configure script determines whether the object file symbol tables
1164 have a leading underscore, and sets @LeadingUnderscore@ accordingly.
1165 (The driver script `sees' the setting of the @LeadingUnderscore@
1166 by having the Makefile prepend it).
1170 local($uscore) = ( ${LeadingUnderscore} eq 'YES' ) ? '_' : '';
1173 (($Ld_main) ? ( '-u', "${uscore}Main_" . $Ld_main . '_closure' ) : ()));
1175 # things that are referenced by the RTS - make sure that we pull 'em in
1177 ( '-u', "${uscore}PrelBase_IZh_static_info"
1178 ,'-u', "${uscore}PrelBase_CZh_static_info"
1179 ,'-u', "${uscore}PrelBase_FZh_static_info"
1180 ,'-u', "${uscore}PrelBase_DZh_static_info"
1181 ,'-u', "${uscore}PrelAddr_AZh_static_info"
1182 ,'-u', "${uscore}PrelAddr_WZh_static_info"
1183 ,'-u', "${uscore}PrelAddr_I64Zh_static_info"
1184 ,'-u', "${uscore}PrelAddr_W64Zh_static_info"
1185 ,'-u', "${uscore}PrelForeign_StablePtr_static_info"
1186 ,'-u', "${uscore}PrelBase_IZh_con_info"
1187 ,'-u', "${uscore}PrelBase_CZh_con_info"
1188 ,'-u', "${uscore}PrelBase_FZh_con_info"
1189 ,'-u', "${uscore}PrelBase_DZh_con_info"
1190 ,'-u', "${uscore}PrelAddr_AZh_con_info"
1191 ,'-u', "${uscore}PrelAddr_WZh_con_info"
1192 ,'-u', "${uscore}PrelAddr_I64Zh_con_info"
1193 ,'-u', "${uscore}PrelAddr_W64Zh_con_info"
1194 ,'-u', "${uscore}PrelForeign_StablePtr_con_info"
1195 ,'-u', "${uscore}PrelBase_False_static_closure"
1196 ,'-u', "${uscore}PrelBase_True_static_closure"
1197 ,'-u', "${uscore}PrelPack_unpackCString_closure"
1199 if (!$NoHaskellMain) {
1200 unshift (@Ld_flags,'-u', "${uscore}PrelMain_mainIO_closure");
1202 if ($TargetPlatform =~ /^powerpc-|^rs6000-/) {
1203 # sometimes we have lots of toc entries...
1204 # unshift(@Ld_flags, ('-Xlinker -bbigtoc -Xlinker -bnoquiet'));
1205 unshift(@Ld_flags, ('-Xlinker -bbigtoc'));
1208 } # end of setupLinkOpts
1212 %************************************************************************
1214 \subsection{Set up include paths and system-library enslurpment}
1216 %************************************************************************
1218 Now that we know what garbage-collector, etc., are required, we can
1219 finalise our list of libraries to slurp through, and generally Get
1224 # default includes must be added AFTER option processing
1225 if ( ! $INSTALLING ) {
1226 push (@Include_dir, "$TopPwd/${CURRENT_DIR}/${GHC_INCLUDE_DIR}");
1228 push (@Include_dir, "$InstLibDirGhc/includes");
1229 push (@Include_dir, "$InstLibDirGhc/includes");
1231 } # end of setupIncPaths
1236 push(@SysLibrary, ( '-lHS', '-lHS_cbits' )); # basic I/O and prelude stuff
1239 foreach $f (@SysLibrary) {
1240 next if $f =~ /_cbits/;
1241 $f .= $BuildTag if $f =~ /^-lHS/;
1244 # Push library HSrts, plus boring clib bit
1245 push(@SysLibrary, "-lHSrts${BuildTag}");
1248 # RTS compiled with cygwin32, uses the WinMM API
1249 # to implement the itimers, since cygwin.dll does not
1250 # support it. Only reqd. for `ways' that use itimers.
1252 push(@SysLibrary, '-lwinmm') if $TargetPlatform eq 'i386-unknown-cygwin32';
1254 # Push the pvm libraries
1255 if ($BuildTag eq '_mp') {
1256 $pvmlib = "$ENV{'PVM_ROOT'}/lib/$ENV{'PVM_ARCH'}";
1257 push(@SysLibrary, "-L$pvmlib", '-lgpvm3', '-lpvm3');
1258 if ( $ENV{'PVM_ARCH'} eq 'SUNMP' ) {
1259 push(@SysLibrary, '-lthread', '-lsocket', '-lnsl');
1260 } elsif ( $ENV{'PVM_ARCH'} eq 'SUN4SOL2' ) {
1261 push(@SysLibrary, '-lsocket', '-lnsl');
1265 # Push the GNU multi-precision arith lib; and the math library
1267 # If this machine has GMP already installed, then we'll get the installed
1268 # lib here, because presumably the one in the tree won't have been built.
1270 if ($LibGmp eq 'not-installed') {
1271 push(@SysLibrary, "-lgmp");
1273 push(@SysLibrary, "-l$LibGmp");
1276 push(@SysLibrary, '-lm');
1279 %************************************************************************
1281 \subsection{Check that this system was built to do what we are asking}
1283 %************************************************************************
1285 Before continuing we check that the appropriate build is available.
1288 #die "$Pgm: no BuildAvail?? $BuildTag\n" if $BuildDescr{$BuildTag} eq '' ; # sanity
1290 if ( $BuildDescr{$BuildTag} eq '' ) {
1291 print STDERR "$Pgm: a `", $BuildDescr{$BuildTag},
1292 "' \"build\" is not available with your GHC setup.\n";
1293 print STDERR "(It was not configured for it at your site.)\n";
1294 print STDERR $ShortUsage;
1298 } # end of setupSyslibs
1302 %************************************************************************
1304 \subsection{Final miscellaneous setup bits before we start going}
1306 %************************************************************************
1308 Record largest specific heapsize, if any.
1310 sub setupHeapStackSize {
1311 $Specific_heap_size = $Specific_heap_size * $Scale_sizes_by;
1312 push(@HsC_rts_flags, '-H'.$Specific_heap_size);
1313 $Specific_stk_size = $Specific_stk_size * $Scale_sizes_by;
1314 push(@HsC_rts_flags, "-K$Specific_stk_size");
1318 If no input or link files seen, then we let 'em feed in stdin; this is
1319 mainly for debugging.
1323 if ($#Input_file < 0 && $#Link_file < 0) {
1324 @Input_file = ( '-' );
1326 open(INF, "> $Tmp_prefix.hs") || &tidy_up_and_die(1,"Can't open $Tmp_prefix.hs\n");
1327 print STDERR "Enter your Haskell program, end with ^D (on a line of its own):\n" if -t;
1328 while (<STDIN>) { print INF $_; }
1329 close(INF) || &tidy_up_and_die(1,"Failed writing to $Tmp_prefix.hs\n");
1334 Tell the world who we are, if they asked.
1336 print STDERR "${ProjectName}, version ${ProjectVersion}, patchlevel ${ProjectPatchLevel}\n"
1340 %************************************************************************
1342 \section[Driver-main-loop]{Main loop: Process input files, and link if required}
1344 %************************************************************************
1346 Process the input files; don't continue with linking if there are
1347 problems (global variable @$Status@ non-zero).
1349 foreach $ifile (@Input_file) {
1350 &ProcessInputFile($ifile);
1353 if ( $Status > 0 ) { # don't link if there were errors...
1354 print STDERR $ShortUsage;
1359 # append last minute flags linker and consistency flags
1366 Link if appropriate.
1369 local($libdirs) = '';
1371 # glue them together:
1372 push(@UserLibrary_dir, @SysLibrary_dir);
1374 $libdirs = '-L' . join(' -L',@UserLibrary_dir) if $#UserLibrary_dir >= 0;
1376 # for a linker, use an explicitly given one, or the going C compiler ...
1377 local($lnkr) = ( $Lnkr ) ? $Lnkr : $CcRegd;
1379 if ( ($Specific_output_file eq '') &&
1380 ($TargetPlatform eq 'i386-unknown-cygwin32') ) {
1381 $Specific_output_file = 'main.exe';
1382 print STDERR "Output file not specified, defaulting to \"main.exe\"\n";
1385 local($output) = ($Specific_output_file ne '') ? "-o $Specific_output_file" : '';
1386 @Files_to_tidy = ($Specific_output_file ne '') ? $Specific_output_file : 'a.out';
1388 local($to_do) = "$lnkr $Verbose @Ld_flags $output @Link_file $TopClosureFile $libdirs @UserLibrary @SysLibrary";
1389 &run_something($to_do, 'Linker');
1391 # finally, check the consistency info in the binary
1392 local($executable) = $Files_to_tidy[0];
1393 @Files_to_tidy = (); # reset; we don't want to nuke it if it's inconsistent
1396 # dynamically load consistency-chking code; then do it.
1397 require('ghc-consist.prl')
1398 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-consist.prl!\n");
1400 &chk_consistency_info ( $executable );
1403 # if PVM parallel stuff, we do truly weird things.
1404 # Essentially: (1) move the executable over to where PVM expects
1405 # to find it. (2) create a script in place of the executable
1406 # which will cause the program to be run, via SysMan.
1407 if ( $PARing eq 'p' ) {
1408 local($pvm_executable) = $executable;
1409 local($pvm_executable_base);
1411 if ( $pvm_executable !~ /^\// ) { # a relative path name: make absolute
1412 local($pwd) = `pwd`;
1414 $pwd =~ s/^\/tmp_mnt//;
1415 $pvm_executable = "$pwd/$pvm_executable";
1418 $pvm_executable =~ s|/|=|g; # make /s into =s
1419 $pvm_executable_base = $pvm_executable;
1421 $pvm_executable = $ENV{'PVM_ROOT'} . '/bin/' . $ENV{'PVM_ARCH'}
1422 . "/$pvm_executable";
1424 &run_something("$Rm -f $pvm_executable; $Cp -p $executable $pvm_executable && $Rm -f $executable", 'Moving binary to PVM land');
1426 # OK, now create the magic script for "$executable"
1427 open(EXEC, "> $executable") || &tidy_up_and_die(1,"$Pgm: couldn't open $executable to write!\n");
1428 print EXEC <<EOSCRIPT1;
1429 eval 'exec perl -S \$0 \${1+"\$@"}'
1430 if \$running_under_some_shell;
1431 # =!=!=!=!=!=!=!=!=!=!=!
1432 # This script is automatically generated: DO NOT EDIT!!!
1433 # Generated by Glasgow Haskell, version ${ProjectVersion} ${ProjectPatchLevel}
1435 \$pvm_executable = '$pvm_executable';
1436 \$pvm_executable_base = '$pvm_executable_base';
1437 \$SysMan = '$SysMan';
1440 print EXEC <<\EOSCRIPT2;
1441 # first, some magical shortcuts to run "commands" on the binary
1443 if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {
1445 system("$cmd $pvm_executable");
1449 # OK, really run it; process the args first
1450 $ENV{'PE'} = $pvm_executable_base;
1452 $nprocessors = 2; # the default
1456 # ToDo: handle --RTS
1457 args: while ($a = shift(@ARGV)) {
1458 if ( $a eq '+RTS' ) {
1460 } elsif ( $a eq '-RTS' ) {
1463 if ( $a eq '-d' && $in_RTS_args ) {
1465 } elsif ( $a =~ /^-N(\d+)/ && $in_RTS_args ) {
1468 push(@nonPVM_args, $a);
1472 local($return_val) = 0;
1473 system("$SysMan $debug $pvm_executable $nprocessors @nonPVM_args");
1475 system("mv $ENV{'HOME'}/$pvm_executable_base.???.gr .") if -f "$ENV{'HOME'}/$pvm_executable_base.001.gr";
1478 close(EXEC) || die "Failed closing $executable\n";
1479 chmod 0755, $executable;
1483 # that... that's all, folks!
1485 exit $Status; # will still be 0 if all went well
1488 %************************************************************************
1490 \section[Driver-do-one-file]{How to process a single input file}
1492 %************************************************************************
1495 sub ProcessInputFile {
1496 local($ifile) = @_; # input file name
1497 local($ifile_root); # root of or basename of input file
1498 local($ofile_target); # ultimate output file we hope to produce
1499 # from input file (need to know for recomp
1500 # checking purposes)
1501 local($hifile_target);# ditto (but .hi file)
1502 local($ofile_c_stub_target);
1503 local($ofile_h_stub_target);
1506 Handle the weirdity of input from stdin.
1508 if ($ifile ne '-') {
1509 ($ifile_root = $ifile) =~ s/\.[^\.\/]+$//;
1510 $ofile_target = # may be reset later...
1511 ($Specific_output_file ne '' && ! $Do_lnkr)
1512 ? $Specific_output_file
1513 : &odir_ify($ifile_root, 'o');
1514 $hifile_target= ($Specific_hi_file ne '')
1516 : "$ifile_root.$HiSuffix"; # ToDo: odirify?
1517 # NB: may change if $ifile_root isn't module name (??)
1518 ($ofile_c_stub_target = $ifile) =~s/\.[^\.\/]+$/_stub.c/;
1519 ($ofile_h_stub_target = $ifile) =~s/\.[^\.\/]+$/_stub.h/;
1521 $ifile = "$Tmp_prefix.hs"; # we know that's where we put the input
1522 $ifile_root = '_stdin';
1523 $ofile_target = '_stdout'; # gratuitous?
1524 $hifile_target= '_stdout'; # ditto?
1528 We need to decide what phases of the compilation system we will run
1529 over this file. The defaults are the ones established when processing
1530 flags. (That established what the last phase run for all files is.)
1532 We do the pre-recompilation-checker phases here; the rest later.
1536 Look at the suffix and decide what initial phases of compilation may
1537 be dropped off for this file. Also the rather boring business of
1538 which files are coming-in/going-out.
1540 Again, we'll do the post-recompilation-checker parts of this later.
1542 local($do_lit2pgm) = ($ifile =~ /\.lhs$/) ? 1 : 0;
1543 local($do_hscpp) = 1; # but "hscpp" might really be "cat"
1546 # names of the files to stuff between phases
1547 # defaults are temporaries
1548 local($in_lit2pgm) = $ifile;
1549 local($lit2pgm_hscpp) = "$Tmp_prefix.lpp";
1550 local($hscpp_hsc) = "$Tmp_prefix.cpp";
1551 local($hsc_hi) = "$Tmp_prefix.hi";
1552 local($cc_as_o) = "${Tmp_prefix}_o.s"; # temporary for raw .s file if opt C
1553 local($cc_as) = "$Tmp_prefix.s"; # mangled or hsc-produced .s code
1554 local($as_out) = $ofile_target;
1556 local($is_hc_file) = 1; #Is the C code .hc or .c? Assume .hc for now
1558 # OK, let's strip off some literate junk..
1560 &runLit2pgm($in_lit2pgm, $lit2pgm_hscpp)
1562 $lit2pgm_hscpp = $ifile;
1568 # Scan the top of the de-litted file for {-# OPTIONS #-} pragmas
1569 &check_for_source_options($lit2pgm_hscpp,$ifile);
1571 # Options found in the source file take a back seat, i.e., we scan
1572 # them first. Only process the command line again if source file
1573 # contained anything of interest *or* there's more than one
1574 # input file (we have to reset the options).
1576 if ( $#Input_file >= 0 || $#File_options >= 0) {
1577 #@File_options = (@File_options, @Cmd_opts);
1579 # Now process the command line
1580 &initDriverGlobals();
1581 &processArgs((@File_options,@Cmd_opts));
1582 print STDERR "\nEffective command line: " .
1583 join(' ',(@File_options,@Cmd_opts)) . "\n" if $Verbose;
1586 # Having got the effective command line scanned, set up
1587 # the various options in prep for some real work.
1589 # check the sanity of the BuildTag we're about to use,
1590 # and if needs be, add some more flags and setup to
1591 # the different phases.
1594 &setupOptimiseFlags();
1597 &setupWarningFlags();
1598 &setupHeapStackSize();
1601 # These two variables need to be set after the
1602 # command-line has been processed and the build options
1603 # have be seen set up. This is because command-line options
1604 # can control whether to compile vias C or not.
1606 local($do_cc) = ( $Do_cc != -1) # i.e., it was set explicitly
1608 : ( ($HscOut eq '-C=') ? 1 : 0 );
1609 local($do_as) = $Do_as;
1610 local($hsc_out) = ( $HscOut eq '-C=' ) ? "$Tmp_prefix.hc" : "$Tmp_prefix.s" ;
1611 local($hsc_out_c_stub) = ( $HscOut eq '-C=' ) ? "${Tmp_prefix}_stb.c" : "";
1612 local($hsc_out_h_stub) = ( $HscOut eq '-C=' ) ? "${Tmp_prefix}_stb.h" : "";
1614 if ($Only_preprocess_hc) { # stop after having run $Cc -E
1617 if ($Only_preprocess_C) { # stop after having run $hscpp
1618 $do_hsc=0; $do_cc = 0; $do_as=0;
1619 } elsif ($ifile =~ /.lhs$/ || $ifile =~ /.hs$/ ) {
1621 } elsif ($ifile =~ /\.hc$/ || $ifile =~ /_hc$/ ) { # || $ifile =~ /\.$Isuffix$/o) # ToDo: better
1622 $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
1624 $hsc_out_c_stub = '';
1625 $hsc_out_h_stub = '';
1626 } elsif ($ifile =~ /\.c$/) {
1627 $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
1628 $hsc_out = $ifile; $is_hc_file = 0;
1629 $hsc_out_c_stub = '';
1630 $hsc_out_h_stub = '';
1631 } elsif ($ifile =~ /\.[sS]$/) {
1632 $do_hscpp = 0; $do_hsc = 0; $do_cc = 0;
1634 } else { # don't know what it is, but nothing to do herein...
1635 $do_hscpp = 0; $do_hsc = 0; $do_cc = 0; $do_as = 0;
1638 # hack to avoid running hscpp
1639 $HsCpp = $Cat if ! $Cpp_flag_set;
1641 &runHscpp($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc) if $do_hscpp;
1645 We now think about whether to run hsc/cc or not (when hsc produces .s
1646 stuff, it effectively takes the place of both phases).
1647 To get the output file name right: for each phase that we are {\em
1648 not} going to run, set its input (i.e., the output of its preceding
1649 phase) to @"$ifile_root.<suffix>"@.
1652 local($going_interactive) = $HscOut eq '-N=' || $ifile_root eq '_stdin';
1655 # Warning issued if -keep-hc-file-too is used without
1656 # -fvia-C (or the equivalent)
1658 if ( $HscOut ne '-C=' && $Keep_hc_file_too ) {
1659 print STDERR "$Pgm: warning: Native code generator to be used, -keep-hc-file-too will be ignored\n";
1662 if (! $do_cc && ! $do_as) { # stopping after hsc
1663 $hsc_out = ($Specific_output_file ne '')
1664 ? $Specific_output_file
1665 : &odir_ify($ifile_root, ($HscOut eq '-C=') ? 'hc' : 's');
1667 $ofile_target = $hsc_out; # reset
1670 if (! $do_as) { # stopping after gcc (or hsc)
1671 $cc_as = ($Specific_output_file ne '')
1672 ? $Specific_output_file
1673 : &odir_ify($ifile_root, ( $Only_preprocess_hc ) ? 'i' : 's');
1675 $ofile_target = $cc_as; # reset
1681 Now the Haskell compiler, C compiler, and assembler
1685 &runHscAndProcessInterfaces( $ifile, $hscpp_hsc, $ifile_root,
1686 $ofile_target, $hifile_target,
1687 $going_interactive);
1690 if (-f $hsc_out_h_stub) {
1691 &run_something("cp $hsc_out_h_stub $ofile_h_stub_target", 'Copy foreign export header file');
1694 if (-f $hsc_out_c_stub) {
1695 &run_something("cp $hsc_out_c_stub $ofile_c_stub_target", 'Copy foreign export C stubs');
1696 local ($hsc_out_s_stub);
1697 local ($hsc_out_o_stub);
1698 ($ofile_s_stub_target = $ofile_c_stub_target) =~ s/\.(.*)$/\.s/;
1699 ($ofile_o_stub_target = $ofile_c_stub_target) =~ s/\.(.*)$/\.o/;
1700 &runGcc (0, $ofile_c_stub_target, $ofile_s_stub_target);
1701 &runAs ($ofile_o_stub_target, $ofile_s_stub_target);
1703 # Bring the C stub protos into scope when compiling the .hc file.
1705 push (@CcInjects, "#include \"${hsc_out_h_stub}\"\n");
1706 # Hack - ensure that the stub .h file is included in the OPTIONS section
1707 # if the .hc file is saved.
1708 push (@File_options, "-#include \"${ofile_h_stub_target}\"\n");
1713 &runGcc ($is_hc_file, $hsc_out, $cc_as_o);
1714 &runMangler($is_hc_file, $cc_as_o, $cc_as, $ifile_root) if ! $Only_preprocess_hc;
1717 &split_asm_file($cc_as) if $do_as && $SplitObjFiles;
1719 # save a copy of the .s file..
1720 &saveIntermediate($ifile_root , "s" , $cc_as) if ($do_as && $Keep_s_file_too);
1721 &runAs($as_out, $ifile_root) if $do_as;
1724 Finally, decide what to queue up for linker input.
1726 # tentatively assume we will eventually produce linker input:
1727 push(@Link_file, &odir_ify($ifile_root, 'o'));
1729 #ToDo: local($or_isuf) = ($Isuffix eq '') ? '' : "|$Isuffix";
1731 if ( $ifile !~ /\.(lhs|hs|hc|c|s|a|S)$/ && $ifile !~ /_hc$/ ) {
1732 # There's sometimes confusion regarding .hi files; users
1733 # supplying them on the command line.
1734 if ( $ifile =~ /\.hi$/ ) {
1735 print STDERR "$Pgm: warning: found `$ifile' on command line; interface files should not be supplied here - ignoring it.\n";
1737 print STDERR "$Pgm: don't recognise suffix on `$ifile'; passing it through to linker\n";
1739 # oops; we tentatively pushed the wrong thing; fix & do the right thing
1740 pop(@Link_file); push(@Link_file, $ifile);
1744 } # end of ProcessInputFile
1747 %************************************************************************
1749 \section[Driver-run-phases]{Routines to run the various phases}
1751 %************************************************************************
1755 local($in_lit2pgm, $lit2pgm_hscpp) = @_;
1759 # Only add #line pragma if we're going to need it.
1760 $to_do = "echo '#line 1 \"$in_lit2pgm\"' > $lit2pgm_hscpp && " if ($Cpp_flag_set);
1761 $to_do .= "$Unlit @Unlit_flags $in_lit2pgm - >> $lit2pgm_hscpp";
1763 push(@Files_to_tidy, $lit2pgm_hscpp );
1765 &run_something($to_do, 'literate pre-processor');
1771 local($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc) = @_;
1775 # Strictly speaking, echoing of the following line pragma is only required
1776 # on non-delit'ed input, as we've already added it during de-lit. However,
1777 # hscpp will then add a {-# LINE 1 "$lit2pgm_hsc" -} to the top of the file,
1778 # which is not very informative (but harmless). Hence, we uniformly have
1779 # {-# LINE 1 "$in_lit2pgm" #-} as the first line to all cpp'ed hsc input.
1781 $to_do = "echo '{-# LINE 1 \"$in_lit2pgm\" -}' > $hscpp_hsc && ";
1783 if ($HsCpp eq $Cat) {
1784 $to_do .= "$HsCpp $lit2pgm_hscpp >> $hscpp_hsc";
1785 push(@Files_to_tidy, $hscpp_hsc );
1786 &run_something($to_do, 'Ineffective C pre-processor');
1788 local($includes) = '-I' . join(' -I',@Include_dir);
1789 $to_do .= "$HsCpp $Verbose @HsCpp_flags @HsSourceCppOpts $includes $lit2pgm_hscpp >> $hscpp_hsc";
1790 push(@Files_to_tidy, $hscpp_hsc );
1791 &run_something($to_do, 'Haskellised C pre-processor');
1794 if ( $Only_preprocess_C ) {
1795 $to_do = "$Cat $hscpp_hsc";
1796 &run_something($to_do, '');
1804 sub runHscAndProcessInterfaces {
1805 local($ifile, $hscpp_hsc, $ifile_root,
1806 $ofile_target, $hifile_target,
1807 $going_interactive) = @_;
1809 # $ifile is the original input file
1810 # $hscpp_hsc post-unlit, post-cpp, etc., input file
1811 # $ifile_root input filename minus suffix
1812 # $ofile_target the output file that we ultimately hope to produce
1813 # $hifile_target the .hi file ... (ditto)
1815 local($source_unchanged) = 1;
1817 # Check if the source file is up to date relative to the target; in
1818 # that case we say "source is unchanged" and let the compiler bail out
1819 # early if the import usage information allows it.
1821 ($i_dev,$i_ino,$i_mode,$i_nlink,$i_uid,$i_gid,$i_rdev,$i_size,
1822 $i_atime,$i_mtime,$i_ctime,$i_blksize,$i_blocks) = stat($ifile);
1824 # The informational messages below are now conditional on -v being set -- SOF
1825 if ( $ofile_target ne "_stdin.s" && ! -f $ofile_target ) {
1826 print STDERR "$Pgm:compile:Output file $ofile_target doesn't exist\n" if $Verbose;
1827 $source_unchanged = 0;
1830 ($o_dev,$o_ino,$o_mode,$o_nlink,$o_uid,$o_gid,$o_rdev,$o_size,
1831 $o_atime,$o_mtime,$o_ctime,$o_blksize,$o_blocks) = stat(_); # stat info from -f test
1833 if ( $hifile_target ne "_stdout" && ! -f $hifile_target ) {
1834 print STDERR "$Pgm:compile:Interface file $hifile_target doesn't exist\n" if $Verbose;
1835 $source_unchanged = 0;
1838 ($hi_dev,$hi_ino,$hi_mode,$hi_nlink,$hi_uid,$hi_gid,$hi_rdev,$hi_size,
1839 $hi_atime,$hi_mtime,$hi_ctime,$hi_blksize,$hi_blocks) = stat(_); # stat info from -f test
1841 if ( $ofile_target ne "_stdin.s" && $i_mtime > $o_mtime) {
1842 print STDERR "$Pgm:recompile:Input file $ifile newer than $ofile_target\n" if $Verbose;
1843 $source_unchanged = 0;
1846 # Tell the compiler which version we're using
1847 push(@HsC_flags, "-fhi-version=${ProjectVersionInt}");
1849 # So if source_unchanged is still "1", we pass on the good news to the compiler
1850 # The -recomp flag can disable this, forcing recompilation
1851 if ($Do_recomp_chkr && $source_unchanged) {
1852 push(@HsC_flags, '-fsource-unchanged');
1857 &runHsc($ifile_root, $hsc_out, $hsc_hi, $hsc_out_c_stub, $hsc_out_h_stub, $going_interactive);
1859 # See if it bailed out early, saying nothing needed doing.
1860 # We work this out by seeing if it created an output .hi file
1862 if ( ! -f $hsc_hi && $ProduceHi !~ /-nohifile=/ ) {
1863 # Doesn't exist, so we bailed out early.
1864 # Tell the C compiler and assembler not to run
1865 $do_cc = 0; $do_as = 0;
1867 # Update dependency info, touch both object file and
1868 # interface file, so that the following invariant is
1871 # a dependent module's interface file should after recompilation
1872 # checking be newer than the interface files of its imports.
1874 # That is, if module A's interface file changes, then module B
1875 # (which import from A) needs to be checked.
1876 # If A's change does not affect B, which causes the compiler to bail
1877 # out early, we still need to touch the interface file of B. The reason
1878 # for this is that B may export A's interface.
1880 &run_something("touch $ofile_target",
1881 "Touch $ofile_target, to propagate dependencies") if $HscOut ne '-N=';
1882 &run_something("touch $hifile_target",
1883 "Touch $hifile_target, to propagate dependencies") if $ProduceHi =~ /-nohifile=/ ;
1887 # Didn't bail out early (new .hi file) so we thunder on
1889 # If non-interactive, heave in the consistency info at the end
1890 # NB: pretty hackish (depends on how $output is set)
1891 if ( ! $going_interactive ) {
1892 if ( $HscOut eq '-C=' ) {
1893 $to_do = "echo 'static char ghc_hsc_ID[] = \"\@(#)hsc $ifile\t$HsC_major_version.$HsC_minor_version,$HsC_consist_options\";' >> $hsc_out";
1895 } elsif ( $HscOut eq '-S=' ) {
1896 local($consist) = "hsc.$ifile.$HsC_major_version.$HsC_minor_version.$HsC_consist_options";
1897 $consist =~ s/,/./g;
1898 $consist =~ s/\//./g;
1899 $consist =~ s/-/_/g;
1900 $consist =~ s/[^A-Za-z0-9_.]/ZZ/g; # ToDo: properly?
1901 $to_do = "echo '\n\t.text\n$consist:' >> $hsc_out";
1903 &run_something($to_do, 'Pin on Haskell consistency info');
1907 # Interface-handling is important enough to live off by itself
1908 if ( $ProduceHi !~ /-nohifile=/ ) { # If we've produced one, process it.
1909 require('ghc-iface.prl') || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-iface.prl!\n");
1910 &postprocessHiFile($hsc_hi, $hifile_target, $going_interactive);
1912 # if we're going to split up object files,
1913 # we inject split markers into the .hc file now
1914 if ( $HscOut eq '-C=' && $SplitObjFiles ) {
1915 &inject_split_markers ( $hsc_out );
1918 # save a copy of the .hc file, even if we are carrying on...
1919 if ($HscOut eq '-C=' && $do_cc && $Keep_hc_file_too) {
1920 &saveIntermediate($ifile_root , "hc" , $hsc_out);
1930 local($ifile_root, $hsc_out, $hsc_hi, $hsc_out_c_stub, $hsc_out_h_stub, $going_interactive) = @_;
1932 # prepend comma to HsP flags (so hsc can tell them apart...)
1933 foreach $a ( @HsP_flags ) { $a = ",$a" unless $a =~ /^,/; }
1935 &makeHiMap() unless $HiMapDone;
1936 push(@HsC_flags, "-himap=$HiIncludeString");
1938 # here, we may produce .hc/.s and/or .hi files
1939 local($output) = '';
1940 #@Files_to_tidy = ();
1942 if ( $going_interactive ) {
1943 # don't need .hi unless we're going to show it on stdout:
1944 $ProduceHi = '-nohifile=' if ! $HiOnStdout;
1945 $do_cc = 0; $do_as = 0; $Do_lnkr = 0; # and we won't go any further...
1948 # set up for producing output/.hi; note that flag twiddling
1949 # may mean that nothing will actually be produced:
1950 $output = "$ProduceHi$hsc_hi $HscOut$hsc_out -F=$hsc_out_c_stub -FH=$hsc_out_h_stub";
1951 push(@Files_to_tidy, $hsc_hi, $hsc_out, $hsc_out_c_stub, $hsc_out_h_stub );
1953 # if we're compiling foo.hs, we want the GC stats to end up in foo.stat
1954 if ( $CollectingGCstats ) {
1955 push(@HsC_rts_flags, "-S$ifile_root.stat");
1956 push(@Files_to_tidy, "$ifile_root.stat");
1959 if ( $CollectGhcTimings ) { # assume $RTS_style eq 'ghc'
1960 # emit nofibbish time/bytes-alloc stats to stderr;
1961 # see later .stat file post-processing
1962 print STDERR "warning: both -Rgc-stats and -Rghc-timing used, -Rghc-timing wins." if $CollectingGCstats;
1963 push(@HsC_rts_flags, "-s$Tmp_prefix.stat");
1964 push(@Files_to_tidy, "$Tmp_prefix.stat");
1968 if ($Specific_dump_file ne '') {
1969 $dump = "2>> $Specific_dump_file";
1970 $Using_dump_file = 1;
1974 # Win32 only: If the command processor used by system()
1975 # exec()s the application as an ordinary Win32 executable,
1976 # we're in trouble here, since the command line is likely
1977 # to be > 255 chars long. To work around this situation,
1978 # $HsC also understands `at-files', i.e., `@file' on the
1979 # command line will cause $HsC to add the contents of `file'
1980 # to the command line.
1982 # [ Note: support for `at-files' is not compiled in by default ]
1983 $cmd_line_opts_via_at_file=0;
1984 if ($cmd_line_opts_via_at_file) {
1986 local($to_do_opts) = "$Tmp_prefix.opts";
1987 open(OPTS, "> $Tmp_prefix.opts") || &tidy_up_and_die(1,"Can't open $Tmp_prefix.opts\n");
1988 print OPTS "$dump @HsC_flags $CoreLint $StgLint $Verbose";
1990 $to_do = "$HsC @HsP_flags ,$hscpp_hsc \@$Tmp_prefix.opts $output +RTS @HsC_rts_flags";
1994 $to_do = "$HsC @HsP_flags ,$hscpp_hsc $dump @HsC_flags $CoreLint $StgLint $Verbose $output +RTS @HsC_rts_flags";
1996 &run_something($to_do, 'Haskell compiler');
1998 # finish business w/ nofibbish time/bytes-alloc stats
1999 &process_ghc_timings() if $CollectGhcTimings;
2003 Use \tr{@Import_dir} and \tr{@SysImport_dir} to make a tmp file
2004 of (module-name, pathname) pairs, one per line, separated by a space.
2007 $HiIncludeString = (); # dir1:dir2:dir3, to pass to GHC
2011 # collect in %HiMap; write later; also used elsewhere in driver
2013 local($mod, $path, $d, $e);
2015 # reset the global variables:
2017 $HiIncludeString = (); # dir1:dir2:dir3, to pass to GHC
2019 foreach $d ( @Import_dir ) {
2020 if ($HiIncludeString) {
2021 $HiIncludeString = "$HiIncludeString:${d}%.${HiSuffix}";
2023 $HiIncludeString = "$d%.${HiSuffix}";
2028 foreach $d ( @SysImport_dir ) {
2029 if ($HiIncludeString) {
2030 $HiIncludeString = "$HiIncludeString:${d}%.${HiSuffix_prelude}";
2032 $HiIncludeString = "${d}%.${HiSuffix_prelude}";
2041 %************************************************************************
2043 \section[Driver-misc-utils]{Miscellaneous utilities}
2045 %************************************************************************
2047 %************************************************************************
2049 \subsection[Driver-odir-ify]{@odir_ify@: Mangle filename if \tr{-odir} set}
2051 %************************************************************************
2055 local($ofile,$def_suffix) = @_;
2057 return(($Osuffix eq '') ? "$ofile.$def_suffix" : "$ofile.$Osuffix" );
2061 local($orig_file, $def_suffix) = @_;
2062 if ($Specific_output_dir eq '') { # do nothing
2063 &osuf_ify($orig_file, $def_suffix);
2065 local ($orig_file_only);
2066 ($orig_file_only = $orig_file) =~ s|.*/||;
2067 &osuf_ify("$Specific_output_dir/$orig_file_only",$def_suffix);
2074 local($is_hc_file, $hsc_out, $cc_as_o) = @_;
2076 local($includes) = '-I' . join(' -I', @Include_dir);
2079 local($c_flags) = "@CcBoth_flags";
2080 local($ddebug_flag) = ( $DEBUGging ) ? '-DDEBUG' : '';
2082 # "input" files to use that are not in some weird directory;
2083 # to help C compilers grok .hc files [ToDo: de-hackify]
2084 local($cc_help) = "ghc$$.c";
2085 local($cc_help_s) = "ghc$$.s";
2088 $s_output = (($is_hc_file && $DoAsmMangling) || $TargetPlatform =~ /^(powerpc|rs6000|hppa)/) ? $cc_as_o : $cc_as;
2089 $c_flags .= " @CcRegd_flags";
2090 $c_flags .= ($is_hc_file) ? " @CcRegd_flags_hc" : " @CcRegd_flags_c";
2092 # C compiler won't like the .hc extension. So we create
2093 # a tmp .c file which #include's the needful.
2094 open(TMP, "> $cc_help") || &tidy_up_and_die(1,"$Pgm: failed to open `$cc_help' (to write)\n");
2095 if ( $is_hc_file ) {
2099 # user may have asked for #includes to be injected...
2100 print TMP @CcInjects if $#CcInjects >= 0;
2102 # Straight .c files may want to know that they're being used
2103 # with a particular version of GHC, so we define __GLASGOW_HASKELL__ for their benefit.
2104 print TMP "#define __GLASGOW_HASKELL__ ${ProjectVersionInt}\n";
2106 # heave in the consistency info
2107 print TMP "static char ghc_cc_ID[] = \"\@(#)cc $ifile\t$Cc_major_version.$Cc_minor_version,$Cc_consist_options\";\n";
2109 print TMP "#include \"$hsc_out\"\n";
2110 close(TMP) || &tidy_up_and_die(1,"Failed writing to $cc_help\n");
2112 # Don't redirect stderr into intermediate file if slamming output onto stdout (e.g., with -E)
2113 local($fuse_stderr) = "2>&1" if ! $Only_preprocess_hc;
2114 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 )";
2116 if ( $Only_preprocess_hc ) { # HACK ALERT!
2117 $to_do =~ s/ -S\b//g;
2119 push(@Files_to_tidy, $cc_help, $cc_help_s, $s_output );
2120 $PostprocessCcOutput = 1 if ! $Only_preprocess_hc; # hack, dear hack...
2121 &run_something($to_do, 'C compiler');
2122 $PostprocessCcOutput = 0;
2123 if ( $Only_preprocess_hc ) {
2124 system("$Cat $Tmp_prefix.ccout");
2126 unlink($cc_help, $cc_help_s);
2132 local($is_hc_file, $cc_as_o, $cc_as, $ifile_root) = @_;
2134 print STDERR `cat $cc_as_o` if $Dump_raw_asm; # to stderr, before mangling
2136 if ($is_hc_file && $DoAsmMangling) {
2137 # dynamically load assembler-fiddling code, which we are about to use:
2138 require('ghc-asm.prl')
2139 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm.prl!\n");
2140 # post-process the assembler [.hc files only]
2141 &mangle_asm($cc_as_o, $cc_as);
2143 } elsif ($TargetPlatform =~ /^hppa/) {
2144 # minor mangling of non-threaded files for hp-pa only
2145 require('ghc-asm.prl')
2146 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-hppa.prl!\n");
2147 &mini_mangle_asm_hppa($cc_as_o, $cc_as);
2149 } elsif ($TargetPlatform =~ /^powerpc|^rs6000/) {
2150 # minor mangling of non-threaded files for powerpcs and rs6000s
2151 require('ghc-asm.prl')
2152 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-powerpc.prl!\n");
2153 &mini_mangle_asm_powerpc($cc_as_o, $cc_as);
2156 # save a copy of the .s file, even if we are carrying on...
2157 #if ($do_as && $Keep_s_file_too) {
2158 # &saveIntermediate($ifile_root , "s" , $cc_as);
2165 local($as_out, $ifile_root) = @_;
2167 local($asmblr) = ( $As ) ? $As : $CcRegd;
2169 # need to add the -I flags in case the file is going through cpp (.S files)
2170 local($includes) = '-I' . join(' -I', @Include_dir);
2172 if ( ! $SplitObjFiles ) {
2173 local($to_do) = "$asmblr -o $as_out -c @As_flags $includes $cc_as";
2174 push(@Files_to_tidy, $as_out );
2175 &run_something($to_do, 'Unix assembler');
2177 } else { # more complicated split-ification...
2179 # must assemble files $Tmp_prefix__[1 .. $NoOfSplitFiles].s
2181 # If -odir is used, great, just pin it in front of the
2182 # generated split file names. If it hasn't been set, we
2183 # snatch it from the ifile_root.
2187 if ( $Specific_output_dir eq '' ) {
2188 $Specific_output_dir = ${ifile_root};
2191 for ($f = 1; $f <= $NoOfSplitFiles; $f++ ) {
2192 local($split_out) = &odir_ify("${ifile_root}__${f}",'o');
2193 local($to_do) = "$asmblr -o $split_out -c @As_flags ${Tmp_prefix}__${f}.s";
2194 push(@Files_to_tidy, $split_out );
2196 &run_something($to_do, 'Unix assembler');
2202 %************************************************************************
2204 \subsection[Driver-run-something]{@run_something@: Run a phase}
2206 %************************************************************************
2210 local($str_to_do, $tidy_name) = @_;
2212 print STDERR "\n$tidy_name:\n\t" if $Verbose;
2213 print STDERR "$str_to_do\n" if $Verbose;
2215 if ($Using_dump_file) {
2216 open(DUMP, ">> $Specific_dump_file")
2217 || &tidy_up_and_die(1,"$Pgm: failed to open `$Specific_dump_file'\n");
2218 print DUMP "\nCompilation Dump for: $str_to_do\n\n";
2220 || &tidy_up_and_die(1,"$Pgm: failed closing `$Specific_dump_file'\n");
2223 local($return_val) = 0;
2225 if ( length($str_to_do) > 4000) {
2226 # 4000 - on the random side, just like the *real* ARG_MAX
2229 # With some shells, command lines of this length may
2230 # very well cause trouble. To safeguard against this, we squirrel the
2231 # command into a file and exec that.
2232 local ($sh) = $ENV{'REAL_SHELL'};
2233 print STDERR "Backup plan A: saving cmd line in ${Tmp_prefix}.sh and executing that with $sh\n" if $Verbose;
2234 open (TEMP, "> ${Tmp_prefix}.sh") ||
2235 &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.sh'\n");
2236 print TEMP "$Time $str_to_do\n";
2238 &tidy_up_and_die(1,"$Pgm: failed closing `$Tmp_prefix.sh'\n");
2239 system("$sh $Tmp_prefix.sh");
2242 unlink "${Tmp_prefix}.sh";
2244 system("$Time $str_to_do");
2248 if ( $PostprocessCcOutput ) { # hack, continued
2249 open(CCOUT, "< $Tmp_prefix.ccout")
2250 || &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.ccout'\n");
2252 next if /call-clobbered/;
2253 next if /control reaches end/;
2254 next if /from .*Stg\.h:/;
2255 next if /from ghc\d+.c:\d+:/;
2256 next if /: At top level:$/;
2257 next if /: In function \`.*\':$/;
2258 next if /\`ghc_cc_ID\' defined but not used/;
2261 close(CCOUT) || &tidy_up_and_die(1,"$Pgm: failed closing `$Tmp_prefix.ccout'\n");
2264 if ($return_val != 0) {
2265 if ($Using_dump_file) {
2266 print STDERR "Compilation Errors dumped in $Specific_dump_file\n";
2268 &tidy_up_and_die($return_val, '');
2270 $Using_dump_file = 0;
2274 %************************************************************************
2276 \subsection[Driver-ghc-timing]{Emit nofibbish GHC timings}
2278 %************************************************************************
2280 NB: nearly the same as in @runstdtest@ script.
2283 sub process_ghc_timings {
2284 local($StatsFile) = "$Tmp_prefix.stat";
2285 local($SysSpecificTiming) = 'ghc';
2287 open(STATS, $StatsFile) || die "Failed when opening $StatsFile\n";
2288 local($max_live) = 0;
2289 local($tot_live) = 0; # for calculating residency stuff
2290 local($tot_samples) = 0;
2293 if (! /Minor/ && /^\s*\d+\s+\d+\s+(\d+)\s+\d+\.\d+\%/ ) {
2294 $max_live = $1 if $max_live < $1;
2298 $BytesAlloc = $1 if /^\s*([0-9,]+) bytes allocated in the heap/;
2300 if ( /^\s*([0-9,]+) bytes maximum residency .* (\d+) sample/ ) {
2301 $MaxResidency = $1; $ResidencySamples = $2;
2304 $GCs = $1 if /^\s*([0-9,]+) (collections? in generation 0|garbage collections? performed)/;
2306 # The presence of -? in the following pattern is only there to
2307 # accommodate 0.29 && <= 2.05 RTS'
2308 if ( /^\s*INIT\s+time\s*(\d+\.\d\d)s\s*\(\s*-?(\d+\.\d\d)s elapsed\)/ ) {
2309 $InitTime = $1; $InitElapsed = $2;
2310 } elsif ( /^\s*MUT\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2311 $MutTime = $1; $MutElapsed = $2;
2312 } elsif ( /^\s*GC\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2313 $GcTime = $1; $GcElapsed = $2;
2316 close(STATS) || die "Failed when closing $StatsFile\n";
2317 if ( $tot_samples > 0 ) {
2318 $ResidencySamples = $tot_samples;
2319 $MaxResidency = $max_live;
2320 $AvgResidency = int ($tot_live / $tot_samples) ;
2323 # warn about what we didn't find
2324 print STDERR "Warning: BytesAlloc not found in stats file\n" unless defined($BytesAlloc);
2325 print STDERR "Warning: GCs not found in stats file\n" unless defined($GCs);
2326 print STDERR "Warning: InitTime not found in stats file\n" unless defined($InitTime);
2327 print STDERR "Warning: InitElapsed not found in stats file\n" unless defined($InitElapsed);
2328 print STDERR "Warning: MutTime not found in stats file\n" unless defined($MutTime);
2329 print STDERR "Warning: MutElapsed not found in stats file\n" unless defined($MutElapsed);
2330 print STDERR "Warning: GcTime inot found in stats file\n" unless defined($GcTime);
2331 print STDERR "Warning: GcElapsed not found in stats file\n" unless defined($GcElapsed);
2333 # things we didn't necessarily expect to find
2334 $MaxResidency = 0 unless defined($MaxResidency);
2335 $AvgResidency = 0 unless defined($AvgResidency);
2336 $ResidencySamples = 0 unless defined($ResidencySamples);
2339 $BytesAlloc =~ s/,//g;
2340 $MaxResidency =~ s/,//g;
2342 $InitTime =~ s/,//g;
2343 $InitElapsed =~ s/,//g;
2345 $MutElapsed =~ s/,//g;
2347 $GcElapsed =~ s/,//g;
2349 # print out what we found
2350 print STDERR "<<$SysSpecificTiming: ",
2351 "$BytesAlloc bytes, $GCs GCs, $AvgResidency/$MaxResidency avg/max bytes residency ($ResidencySamples samples), $InitTime INIT ($InitElapsed elapsed), $MutTime MUT ($MutElapsed elapsed), $GcTime GC ($GcElapsed elapsed)",
2352 " :$SysSpecificTiming>>\n";
2359 %************************************************************************
2361 \subsection[Driver-dying]{@tidy_up@ and @tidy_up_and_die@: Dying gracefully}
2363 %************************************************************************
2367 local($to_do) = "\n$Rm $Tmp_prefix*";
2368 if ( $Tmp_prefix !~ /^\s*$/ ) {
2369 print STDERR "$to_do\n" if $Verbose;
2374 sub tidy_up_and_die {
2375 local($return_val, $msg) = @_;
2377 # delete any files to tidy
2378 print STDERR "deleting... @Files_to_tidy\n" if $Verbose && $#Files_to_tidy >= 0;
2379 unlink @Files_to_tidy if $#Files_to_tidy >= 0;
2383 exit (($return_val == 0) ? 0 : 1);
2387 %************************************************************************
2389 \subsection[Driver-arg-with-arg]{@grab_arg_arg@: Do an argument with an argument}
2391 %************************************************************************
2393 Some command-line arguments take an argument, e.g.,
2394 \tr{-Rmax-heapsize} expects a number to follow. This can either be
2395 given a part of the same argument (\tr{-Rmax-heapsize8M}) or as the
2396 next argument (\tr{-Rmax-heapsize 8M}). We allow both cases.
2398 Note: no error-checking; \tr{-Rmax-heapsize -Rgc-stats} will silently
2399 gobble the second argument (and probably set the heapsize to something
2403 local(*Args, $option, $rest_of_arg) = @_;
2405 if ($rest_of_arg ne '') {
2406 return($rest_of_arg);
2407 } elsif ($#Args >= 0) {
2408 local($temp) = $Args[0]; shift(@Args);
2411 print STDERR "$Pgm: no argument following $option option\n";
2422 #Not in HsC_antiflag ## NO!: and not already in HsC_flags
2424 foreach $f ( @HsC_antiflags ) {
2425 return(0) if $flag eq $f;
2427 # foreach $f ( @HsC_flags ) {
2428 # return(0) if $flag eq $f;
2433 sub squashHscFlag { # pretty terrible
2437 foreach $f ( @HsC_flags ) {
2438 if ($flag eq $f) { $f = ''; }
2446 foreach $f ( @flags ) {
2447 push( @HsC_flags, $f ) if &isntAntiFlag($f);
2452 To add another system library, you'll need to augment the
2453 Supported_syslibs variable with name and info on your addition
2454 to the syslib family. The info bit consist of the following:
2456 - interface file directory
2457 see the misc or posix entry for how to distinguish
2458 between using installed and build tree directories.
2460 - directory location of archives
2462 - location of (way-independent) C support libs.
2463 not all libraries need this - if you don't, just
2464 give the empty string.
2465 - list of syslibs you depend on.
2467 - additional ghc command line flags that should be used.
2468 - additional C compiler command line flags that should be used.
2474 # Hash to keep track of
2475 %Syslibs_added = ();
2478 local($syslib) = @_;
2480 # Lifting this out of this sub brings it out of scope - why??
2481 %Supported_syslibs =
2483 [ # where to slurp interface files from
2485 ? "$InstLibDirGhc/imports/exts"
2486 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/exts"
2488 , # where to find the archive to use when linking
2491 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/exts"
2494 , '' # Syslib dependencies
2495 , '' # extra ghc opts
2496 , '' # extra cc opts
2497 , '' # extra ld opts
2501 [ # where to slurp interface files from
2503 ? "$InstLibDirGhc/imports/misc"
2504 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/misc"
2506 , # where to find the archive to use when linking
2509 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/misc"
2511 , # where to find the cbits archive to use when linking
2514 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/misc/cbits"
2516 , 'exts' # Syslib dependencies
2517 , '' # extra ghc opts
2518 , '' # extra cc opts
2519 , ( $TargetPlatform =~ /-solaris2$/ ? '-lnsl -lsocket' : '')
2522 [ # where to slurp interface files from
2524 ? "$InstLibDirGhc/imports/hbc"
2525 : "$TopPwd/CONTRIB/libraries/hbc/src"
2527 , # where to find the archive to use when linking
2530 : "$TopPwd/CONTRIB/libraries/src/hbc"
2532 , # where to find the cbits archive to use when linking
2535 : "$TopPwd/CONTRIB/libraries/hbc/cbits"
2537 , 'exts' # Syslib dependencies
2538 , '' # extra ghc opts
2539 , '' # extra cc opts
2543 [ # where to slurp interface files from
2545 ? "$InstLibDirGhc/imports/posix"
2546 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/posix"
2548 , # where to find the archive to use when linking
2551 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/posix"
2553 , # where to find the cbits archive to use when linking
2556 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/posix/cbits"
2558 , 'misc' # Syslib dependencies
2559 , '' # extra ghc opts
2560 , '' # extra cc opts
2561 , '' # extra ld opts
2564 [ # where to slurp interface files from
2566 ? "$InstLibDirGhc/imports/concurrent"
2567 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/concurrent"
2569 , # where to find the archive to use when linking
2572 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/concurrent"
2574 , '' # where to find the cbits archive to use when linking
2575 , '' # Syslib dependencies
2576 , '' # extra ghc opts
2577 , '' # extra cc opts
2578 , '' # extra ld opts
2581 [ # where to slurp interface files from
2583 ? "$InstLibDirGhc/imports/win32"
2584 : "$TopPwd/hslibs/win32/src"
2586 , # where to find the archive to use when linking
2589 : "$TopPwd/hslibs/win32/src"
2592 , 'exts' # Syslib dependencies
2593 , '' # extra ghc opts
2594 , '' # extra cc opts
2595 , '-luser32 -lgdi32' # extra ld opts
2599 # check if it's supported..
2601 if ( !exists $Supported_syslibs{$syslib} ) {
2602 print STDERR "$Pgm: no such system library (-syslib): $syslib\n";
2607 # This check is here to avoid syslib loops from
2608 # spoiling the party. A side-effect of it is that
2609 # it disallows multiple mentions of a syslib on a command-line,
2610 # explicit *and* implicit ones (i.e., "-syslib exts -syslib misc"
2611 # is not equal to "-syslib exts -syslib misc -syslib exts",
2612 # which it needs to be)
2614 # Since our current collection of syslibs don't have any
2615 # loops, this test is disabled.
2617 # ToDo: loop avoidance scheme when the need arises
2619 #return if ( exists $Syslibs_added{$syslib} );
2621 $Syslibs_added{$syslib} = 1;
2623 local ($hi_dir, $lib_dir, $lib_cbits_dir,
2624 $syslib_deps, $syslib_ghc_opts,
2625 $syslib_cc_opts, $syslib_ld_opts) = @{ $Supported_syslibs{$syslib} };
2628 unshift(@SysImport_dir, $hi_dir);
2629 push(@SysLibrary_dir, $lib_dir);
2630 push(@SysLibrary_dir, $lib_cbits_dir) if ( $lib_cbits_dir ne '');
2632 push(@SysLibrary, "-lHS$syslib");
2633 push(@SysLibrary, "-lHS${syslib}_cbits") if ( $lib_cbits_dir ne '');
2634 push(@SysLibrary, $syslib_ld_opts) if ($syslib_ld_opts ne '');
2636 # Add on any extra dependencies.
2637 foreach $lib (split(' ',$syslib_deps)) {
2643 Source files may have {-# OPTIONS ... #-} pragmas at the top, containing
2644 command line options we want to append to collection of commands specified
2645 directly. @check_for_source_options@ looks at the top of a de-lit'ified Haskell
2646 file for any such pragmas:
2649 sub check_for_source_options {
2650 local($file,$ifile) = @_;
2651 local($comment_start,$comment_end);
2653 if ($ifile =~ /\.hc$/ ||
2656 $ifile =~ /_s$/ ) { # `Real' C intermediate
2657 $comment_start = "/\\*";
2658 $comment_end = "\\*/";
2659 } else { # Assume it is a file containing Haskell source
2660 $comment_start = "{-#";
2661 $comment_end = "#-}";
2664 open(FILE,$file) || return(1); # No big loss
2667 if ( /^${comment_start} OPTIONS (.*)${comment_end}$/ ) {
2668 # add the options found at the back of the command line.
2669 local(@entries) = split(/\s+/,$1);
2670 print STDERR "Found OPTIONS " . join(' ',@entries) . " in $file\n" if $Verbose;
2671 push(@File_options, @entries);
2673 elsif ( /^$/ ) { # ignore empty lines
2676 elsif ( /^#line.+$/ ) { # ignore comment lines (unused..ToDo: rm )
2679 elsif ( /^{-# LINE.+$/ ) { # ignore line pragmas
2682 else { # stop looking, something non-empty / not
2683 # ${comment_start} OPTIONS .. ${comment_end} encountered.
2684 close(FILE);return(0);
2693 We split the initial argv up into three arrays:
2699 the reason for doing so is to be able to deal
2700 with {-# OPTIONS #-} pragma in source files properly.
2706 arg: while($_ = $args[0]) {
2708 # sigh, we have to deal with these -option arg specially here.
2709 /^-(tmpdir|odir|ohi|o|isuf|osuf|hisuf|odump|syslib)$/ &&
2710 do { push(@Cmd_opts, $_); push(@Cmd_opts,$args[0]); shift(@args); next arg; };
2711 /^--?./ && do { push(@Cmd_opts, $_); next arg; };
2713 if (/\.([^_]+_)?[oa]$/) {
2714 push(@Link_file, $_);
2716 push(@Input_file, $_);
2719 # input files must exist:
2721 print STDERR "$Pgm: input file doesn't exist: $_\n";
2729 When saving an intermediate file (.hc or .s) away, we
2730 have to prefix any OPTIONS found in the original source file.
2733 sub saveIntermediate {
2734 local ($final,$suffix,$tmp)= @_ ;
2737 # $final -- root of where to park ${final}.${suffix}
2738 # $tmp -- temporary file where hsc put the intermediate file.
2740 # Delete the old file
2741 $to_do = "$Rm ${final}.${suffix}"; &run_something($to_do, "Removing old .${suffix} file");
2743 if ( $#File_options >= 0 ) { # OPTIONS found in Haskell source unit
2744 # Add OPTION comment to the top of the generated .${suffix} file
2745 open(TEMP, "> ${final}.${suffix}") || &tidy_up_and_die(1,"Can't open ${final}.${suffix}\n");
2746 print TEMP "/* OPTIONS " . join(' ',@File_options) . " */\n";
2748 print STDERR "Prepending OPTIONS: " . join(' ',@File_options) . " to ${final}.${suffix}\n" if $Verbose;
2750 $to_do = "$Cat $tmp >> ${final}.${suffix}";
2751 &run_something($to_do, "Saving copy of .${suffix} file");
2758 Command-line processor
2764 # can't use getopt(s); what we want is too complicated
2766 arg: while($_ = $Args[0]) {
2769 #---------- help -------------------------------------------------------
2770 if (/^-\?$/ || /^--?help$/) { print $LongUsage; exit $Status; }
2772 #-----------version ----------------------------------------------------
2773 /^--version$/ && do { print STDERR "${ProjectName}, version ${ProjectVersion}, patchlevel ${ProjectPatchLevel}\n"; exit $Status; };
2775 #---------- verbosity and such -----------------------------------------
2776 /^-v$/ && do { $Verbose = '-v'; $Time = 'time'; next arg; };
2778 #---------- what phases are to be run ----------------------------------
2779 /^-(no-)?recomp/ && do { $Do_recomp_chkr = ($1 eq '') ? 1 : 0; next arg; };
2781 /^-cpp$/ && do { $Cpp_flag_set = 1; next arg; };
2782 # change the global default:
2783 # we won't run cat; we'll run the real thing
2785 /^-C$/ && do { $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0; $HscOut = '-C=';
2787 # stop after generating C
2789 /^-noC$/ && do { $HscOut = '-N='; $ProduceHi = '-nohifile=';
2790 $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0;
2792 # leave out actual C generation (debugging) [also turns off interface gen]
2795 /^-hi$/ && do { $HiOnStdout = 1; $ProduceHi = '-hifile='; next arg; };
2796 # _do_ generate an interface; usually used as: -noC -hi
2798 /^-nohi$/ && do { $ProduceHi = '-nohifile='; next arg; };
2799 # don't generate an interface (even if generating C)
2801 /^-hi-diffs$/ && do { $HiDiff_flag = 'normal'; next arg; };
2802 /^-hi-diffs-with-usages$/ && do { $HiDiff_flag = 'usages'; next arg; };
2803 /^-no-hi-diffs$/ && do { $HiDiff_flag = ''; next arg; };
2804 /^-keep-hi-diffs$/ && do { $Keep_HiDiffs = 1; next arg; };
2806 # show/disable diffs if the interface file changes
2808 /^-E$/ && do { push(@CcBoth_flags, '-E');
2809 $Only_preprocess_C = 1;
2810 $Do_as = 0; $Do_lnkr = 0; next arg; };
2811 # stop after preprocessing C
2812 /^-M$/ && do { $Only_generate_deps = 1; $Do_as = 0; $Do_lnkr = 0; next arg; };
2813 # only generate dependency information.
2814 /^-S$/ && do { $Do_as = 0; $Do_lnkr = 0; next arg; };
2815 # stop after generating assembler
2817 /^-c$/ && do { $Do_lnkr = 0; next arg; };
2818 # stop after generating .o files
2820 /^-link-chk$/ && do { $LinkChk = 1; next arg; };
2821 /^-no-link-chk$/ && do { $LinkChk = 0; next arg; };
2822 # don't do consistency-checking after a link
2824 /^-tmpdir$/ && do { $Tmp_prefix = &grab_arg_arg(*Args,'-tmpdir', '');
2825 $Tmp_prefix = "$Tmp_prefix/ghc$$";
2826 $ENV{'TMPDIR'} = $Tmp_prefix; # for those who use it...
2828 # use an alternate directory for temp files
2830 #---------- redirect output --------------------------------------------
2832 # -o <file>; applies to the last phase, whatever it is
2833 # "-o -" sends it to stdout
2834 # if <file> has a directory component, that dir must already exist
2836 /^-odir$/ && do { $Specific_output_dir = &grab_arg_arg(*Args,'-odir', '');
2838 # Hack, of the worst sort: don't do validation of
2839 # odir argument if you're using -M (dependency generation).
2841 if ( ! $Only_generate_deps && ! -d $Specific_output_dir) {
2842 print STDERR "$Pgm: -odir: no such directory: $Specific_output_dir\n";
2847 /^-o$/ && do { $Specific_output_file = &grab_arg_arg(*Args,'-o', '');
2848 if ($Specific_output_file ne '-'
2849 && $Specific_output_file =~ /(.*)\/[^\/]*$/) {
2850 local($dir_part) = $1;
2851 if (! -d $dir_part) {
2852 print STDERR "$Pgm: no such directory: $dir_part\n";
2858 # NB: -isuf not documented yet (because it doesn't work yet)
2859 /^-isuf$/ && do { $Isuffix = &grab_arg_arg(*Args,'-isuf', '');
2860 if ($Isuffix =~ /\./ ) {
2861 print STDERR "$Pgm: -isuf suffix shouldn't contain a .\n";
2866 /^-osuf$/ && do { $Osuffix = &grab_arg_arg(*Args,'-osuf', '');
2867 if ($Osuffix =~ /\./ ) {
2868 print STDERR "$Pgm: -osuf suffix shouldn't contain a .\n";
2873 # -ohi <file>; send the interface to <file>; "-ohi -" to send to stdout
2874 /^-ohi$/ && do { $Specific_hi_file = &grab_arg_arg(*Args,'-ohi', '');
2875 if ($Specific_hi_file ne '-'
2876 && $Specific_hi_file =~ /(.*)\/[^\/]*$/) {
2877 local($dir_part) = $1;
2878 if (! -d $dir_part) {
2879 print STDERR "$Pgm: no such directory: $dir_part\n";
2885 # The suffix to use when looking for interface files
2886 /^-hisuf$/ && do { $HiSuffix = &grab_arg_arg(*Args,'-hisuf', '');
2887 if ($HiSuffix =~ /\./ ) {
2888 print STDERR "$Pgm: -hisuf suffix shouldn't contain a .\n";
2892 /^-odump$/ && do { $Specific_dump_file = &grab_arg_arg(*Args,'-odump', '');
2893 if ($Specific_dump_file =~ /(.*)\/[^\/]*$/) {
2894 local($dir_part) = $1;
2895 if (! -d $dir_part) {
2896 print STDERR "$Pgm: no such directory: $dir_part\n";
2902 #-------------- scc & Profiling Stuff ----------------------------------
2904 /^-prof$/ && do { $PROFing = 'p'; next arg; }; # profiling -- details later!
2907 # generate auto SCCs on top level bindings
2908 # -auto-all = all top level bindings
2909 # -auto = only top level exported bindings
2910 $PROFauto = ( /-all/ )
2911 ? '-fauto-sccs-on-all-toplevs'
2912 : '-fauto-sccs-on-exported-toplevs';
2915 /^-caf-all/ && do { # generate individual CAF SCC annotations
2916 $PROFcaf = '-fauto-sccs-on-individual-cafs';
2919 /^-ignore-scc$/ && do {
2920 # forces ignore of scc annotations even if profiling
2921 $PROFignore_scc = '-W';
2924 /^-G(.*)$/ && do { push(@HsC_flags, "-G=$1"); # set group for cost centres
2927 /^-unprof-scc-auto/ && do {
2928 # generate auto SCCs on top level bindings when not profiling.
2929 # Used to measure optimisation effects of presence of sccs.
2930 $UNPROFscc_auto = ( /-all/ )
2931 ? '-fauto-sccs-on-all-toplevs'
2932 : '-fauto-sccs-on-exported-toplevs';
2935 #--------- ticky/parallel ----------------------------------------------
2936 # we sort out the details a bit later on
2938 /^-gransim$/ && do { $GRANing = 'g'; &add_syslib('concurrent'); next arg; }; # GranSim
2939 /^-ticky$/ && do { $TICKYing = 't'; next arg; }; # ticky-ticky
2940 /^-parallel$/ && do { $PARing = 'p'; &add_syslib('concurrent'); next arg; }; # parallel Haskell
2942 #-------------- "user ways" --------------------------------------------
2944 (/^-user-setup-([a-oA-Z])$/ ) &&
2946 /^-user-setup-([a-oA-Z])$/ && do { $BuildTag = "_$1"; };
2948 local($stuff) = $UserSetupOpts{$BuildTag};
2949 local(@opts) = split(/\s+/, $stuff);
2951 # feed relevant ops into the arg-processing loop (if any)
2952 unshift(@Args, @opts) if $#opts >= 0;
2956 #---------- set search paths for libraries and things ------------------
2958 # we do -i just like HBC (-i clears the list; -i<colon-separated-items>
2959 # prepends the items to the list); -I is for including C .h files.
2961 /^-i$/ && do { @Import_dir = (); # import path cleared!
2962 @SysImport_dir = ();
2963 print STDERR "WARNING: import paths cleared by `-i'\n";
2966 /^-i(.*)/ && do { local(@new_items)
2967 = split( /:/, &grab_arg_arg(*Args,'-i', $1));
2968 unshift(@Import_dir, @new_items);
2971 /^-I(.*)/ && do { push(@Include_dir, &grab_arg_arg(*Args,'-I', $1)); next arg; };
2972 /^-L(.*)/ && do { push(@UserLibrary_dir, &grab_arg_arg(*Args,'-L', $1)); next arg; };
2973 /^-l(.*)/ && do { push(@UserLibrary,'-l'.&grab_arg_arg(*Args,'-l', $1)); next arg; };
2975 /^-syslib(.*)/ && do { local($syslib) = &grab_arg_arg(*Args,'-syslib',$1);
2976 &add_syslib($syslib);
2979 #=======================================================================
2980 # various flags that we can harmlessly send to one program or another
2981 # (we will later "reclaim" some of the compiler ones now sent to gcc)
2982 #=======================================================================
2984 #---------- this driver itself (ghc) -----------------------------------
2985 # these change what executable is run for each phase:
2986 /^-pgmL(.*)$/ && do { $Unlit = $1; next arg; };
2987 /^-pgmP(.*)$/ && do { $HsCpp = $1; next arg; };
2988 /^-pgmC(.*)$/ && do { $HsC = $1; next arg; };
2989 /^-pgmcO?(.*)$/ && do { $CcRegd = $1; next arg; }; # the O? for back compat
2990 /^-pgma(.*)$/ && do { $As = $1; next arg; };
2991 /^-pgml(.*)$/ && do { $Lnkr = $1; next arg; };
2992 /^-pgmdep(.*)$/ && do { $MkDependHS = $1; next arg; };
2994 #---------- the get-anything-through opts (all pgms) -------------------
2995 # these allow arbitrary option-strings to go to any phase:
2996 /^-optL(.*)$/ && do { push(@Unlit_flags, $1); next arg; };
2997 /^-optP(.*)$/ && do { push(@HsCpp_flags, $1); next arg; };
2998 /^-optCrts(.*)$/&& do { push(@HsC_rts_flags, $1); next arg; };
2999 /^-optC(.*)$/ && do { push(@HsC_flags, $1); next arg; };
3000 /^-optp(.*)$/ && do { push(@HsP_flags, $1); next arg; };
3001 /^-optcpp(.*)$/ && do { push(@Cpp_define, $1); $Only_preprocess_hc = ($1 eq "-E"); next arg; };
3002 /^-optc(.*)$/ && do { push(@CcBoth_flags, $1); next arg; };
3003 /^-opta(.*)$/ && do { push(@As_flags, $1); next arg; };
3004 /^-optl(.*)$/ && do { push(@Ld_flags, $1); next arg; };
3005 /^-optdep(.*)$/ && do { push(@MkDependHS_flags, $1); next arg; };
3007 #---------- Haskell C pre-processor (hscpp) ----------------------------
3008 /^-D(.*)/ && do { push(@HsCpp_flags, "'-D".&grab_arg_arg(*Args,'-D',$1)."'"); next arg; };
3009 /^-U(.*)/ && do { push(@HsCpp_flags, "'-U".&grab_arg_arg(*Args,'-U',$1)."'"); next arg; };
3011 #---------- post-Haskell "assembler"------------------------------------
3012 /^-ddump-raw-asm$/ && do { $Dump_raw_asm = 1; next arg; };
3013 /^-ddump-asm-splitting-info$/ && do { $Dump_asm_splitting_info = 1; next arg; };
3015 #---------- Haskell compiler (hsc) -------------------------------------
3017 /^-keep-hc-files?-too$/ && do { $Keep_hc_file_too = 1; next arg; };
3018 /^-keep-s-files?-too$/ && do { $Keep_s_file_too = 1; next arg; };
3020 /^-fignore-interface-pragmas$/ && do { push(@HsC_flags, $_); next arg; };
3022 /^-fno-implicit-prelude$/ && do { $NoImplicitPrelude= 1; push(@HsC_flags, $_); next arg; };
3025 # have the compiler proper generate concurrent code,
3026 # really only used when you want to configure your own
3027 # special user compilation way.
3029 # (ditto for -fgransim, fscc-profiling, -fparallel and -fticky-ticky)
3031 /^-fscc-profiling$/ && do { push(@HsC_flags,$_); next arg; };
3032 /^-fticky-ticky$/ && do { push(@HsC_flags,$_); next arg; };
3033 /^-fgransim$/ && do { push(@HsC_flags,$_); next arg; };
3034 /^-fparallel$/ && do { push(@HsC_flags,$_); next arg; };
3036 /^-split-objs$/ && do {
3037 if ( $TargetPlatform !~ /^(alpha|hppa1\.1|i386|m68k|mips|powerpc|rs6000|sparc)-/ ) {
3039 print STDERR "WARNING: don't know how to split objects on this platform: $TargetPlatform\n`-split-objs' option ignored\n";
3044 push(@HsC_flags, "-fglobalise-toplev-names");
3045 push(@CcBoth_flags, '-DUSE_SPLIT_MARKERS');
3047 require('ghc-split.prl')
3048 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-split.prl!\n");
3052 /^-fno-asm-mangling$/ && do { $DoAsmMangling = 0; next arg; };
3054 /^-fallow-overlapping-instances$/ && do { push(@HsC_flags, $_); next arg; };
3055 /^-fallow-undecidable-instances$/ && do { push(@HsC_flags, $_); next arg; };
3057 && do { push(@HsC_flags, $_);
3058 push(@HsP_flags, '-N');
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 # Now the foldr/build options, which are *on* by default (for -O).
3074 && do { $Oopt_FoldrBuild = 1;
3075 $Oopt_FB_Support = '-fdo-arity-expand';
3079 /^-fno-foldr-build$/
3080 && do { $Oopt_FoldrBuild = 0;
3081 $Oopt_FB_Support = '';
3084 /^-fno-foldr-build-rule$/
3085 && do { $Oopt_FoldrBuild = 0;
3088 /^-fno-enable-tech$/
3089 && do { $Oopt_FB_Support = '';
3092 /^-fno-snapback-to-append$/
3093 && do { $Oopt_FoldrBuildInline .= ' -fdo-not-fold-back-append ';
3096 # --------------- Renamer -------------
3099 /^-fno-prune-tydecls$/ && do { push(@HsC_flags, $_); next arg; };
3100 /^-fno-prune-instdecls$/ && do { push(@HsC_flags, $_); next arg; };
3104 /^-fasm-(.*)$/ && do { $HscOut = '-S='; next arg; }; # force using nativeGen
3105 /^-fvia-[cC]$/ && do { $HscOut = '-C='; next arg; }; # force using C compiler
3110 && do { push(@HsC_flags, $_); next arg };
3112 /^-funfold-casms-in-hi-file$/
3113 && do { push(@HsC_flags, $_); next arg };
3115 /^(-fmax-simplifier-iterations)(.*)$/
3116 && do { $Oopt_MaxSimplifierIterations = $1 . &grab_arg_arg(*Args,$1, $2);
3119 /^-fno-pedantic-bottoms$/
3120 && do { $Oopt_PedanticBottoms = ''; next arg; };
3122 /^-fno-pre-inlining$/
3123 && do { push(@HsC_flags, $_); next arg };
3125 /^-fdo-monad-eta-expansion$/
3126 && do { $Oopt_MonadEtaExpansion = $_; next arg; };
3128 /^-fno-let-from-(case|app|strict-let)$/ # experimental, really (WDP 95/10)
3129 && do { push(@HsC_flags, $_); next arg; };
3131 # --------------- Warnings etc. ------
3133 /^-fwarn-(.*)$/ && do { push(@HsC_flags, $_); next arg; };
3135 /^-fno-(.*)$/ && do { push(@HsC_antiflags, "-f$1");
3136 &squashHscFlag("-f$1");
3139 /^-W$/ && do { push(@HsC_flags, @MinusWOpts); next arg; };
3140 /^-Wall$/ && do { push(@HsC_flags, @MinusWallOpts); next arg; };
3141 /^(-Wnot|w)$/ && do { foreach (@Hsc_flags) {
3142 /^-fwarn-(.*)$/ && do { $_=''; };
3144 push(@HsC_antiflags, @StandardWarnings);
3147 # --------------- fun stuff ----------------
3149 /^-freport-compile$/ && do { push(@HsC_flags, $_); next arg; };
3151 # --------------- platform specific flags (for gcc mostly) ----------------
3153 /^-mlong-calls$/ && do { # for GCC for HP-PA boxes,
3154 # for 2.6.x..?, does not apply for 2.7.2
3156 unshift(@CcBoth_flags, ( $_ ));
3159 /^-m(v8|sparclite|cypress|supersparc|cpu=(cypress|supersparc))$/
3160 && do { # for GCC for SPARCs
3161 unshift(@CcBoth_flags, ( $_ ));
3164 /^-monly-([432])-regs/ && do { # for iX86 boxes only; no effect otherwise
3165 $StolenX86Regs = $1;
3168 #*************** ... and lots of debugging ones (form: -d* )
3170 # -d(no-)core-lint is done this way so it is turn-off-able.
3171 /^-dcore-lint/ && do { $CoreLint = '-dcore-lint'; next arg; };
3172 /^-dno-core-lint/ && do { $CoreLint = ''; next arg; };
3173 # Ditto for STG lint
3174 /^-dstg-lint/ && do { $StgLint = '-dstg-lint'; next arg; };
3175 /^-dno-stg-lint/ && do { $StgLint = ''; next arg; };
3177 /^-d(dump|ppr)-/ && do { push(@HsC_flags, $_); next arg; };
3178 /^-dverbose-(simpl|stg)/ && do { push(@HsC_flags, $_); next arg; };
3179 /^-dshow-passes/ && do { push(@HsC_flags, $_); next arg; };
3180 /^-dshow-rn-stats/ && do { push(@HsC_flags, $_); next arg; };
3181 /^-dshow-rn-trace/ && do { push(@HsC_flags, $_); next arg; };
3182 /^-dsource-stats/ && do { push(@HsC_flags, $_); next arg; };
3183 /^-dsimplifier-stats/ && do { push(@HsC_flags, $_); next arg; };
3184 /^-dstg-stats/ && do { $Oopt_StgStats = $_; next arg; };
3186 #*************** ... and now all these -R* ones for its runtime system...
3188 /^-Rscale-sizes?(.*)/ && do {
3189 $Scale_sizes_by = &grab_arg_arg(*Args,'-Rscale-sizes', $1);
3192 /^(-H|-Rmax-heapsize)(.*)/ && do {
3193 local($heap_size) = &grab_arg_arg(*Args,$1, $2);
3194 if ($heap_size =~ /(\d+)[Kk]$/) {
3195 $heap_size = $1 * 1000;
3196 } elsif ($heap_size =~ /(\d+)[Mm]$/) {
3197 $heap_size = $1 * 1000 * 1000;
3198 } elsif ($heap_size =~ /(\d+)[Gg]$/) {
3199 $heap_size = $1 * 1000 * 1000 * 1000;
3201 if ($heap_size <= 0) {
3202 print STDERR "$Pgm: resetting heap-size to zero!!! $heap_size\n";
3203 $Specific_heap_size = 0;
3205 # if several heap sizes given, take the largest...
3206 } elsif ($heap_size >= $Specific_heap_size) {
3207 $Specific_heap_size = $heap_size;
3209 print STDERR "$Pgm: ignoring heap-size-setting option ($_)...not the largest seen\n";
3213 /^(-K|Rmax-(stk|stack)size)(.*)/ && do {
3215 local($stk_size) = &grab_arg_arg(*Args,'-Rmax-stksize', $3);
3216 if ($stk_size =~ /(\d+)[Kk]$/) {
3217 $stk_size = $1 * 1000;
3218 } elsif ($stk_size =~ /(\d+)[Mm]$/) {
3219 $stk_size = $1 * 1000 * 1000;
3220 } elsif ($stk_size =~ /(\d+)[Gg]$/) {
3221 $stk_size = $1 * 1000 * 1000 * 1000;
3223 if ($stk_size <= 0) {
3224 print STDERR "$Pgm: resetting stack-size to zero!!! $stk_size\n";
3225 $Specific_stk_size = 0;
3227 # if several stack sizes given, take the largest...
3228 } elsif ($stk_size >= $Specific_stk_size) {
3229 $Specific_stk_size = $stk_size;
3231 print STDERR "$Pgm: ignoring stack-size-setting option ($flag $stk_size)...not the largest seen\n";
3235 /^-Rgc-stats$/ && do { $CollectingGCstats++;
3236 # the two RTSs do this diff ways; we will try to compensate
3239 /^-Rghc-timing/ && do { $CollectGhcTimings = 1; next arg; };
3241 #---------- C high-level assembler (gcc) -------------------------------
3242 /^-(Wall|ansi|pedantic)$/ && do { push(@CcBoth_flags, $_); next arg; };
3244 # -dgcc-lint is a useful way of making GCC very fussy.
3245 # From alan@spri.levels.unisa.edu.au (Alan Modra).
3246 /^-dgcc-lint$/ && do { push(@CcBoth_flags, '-Wall -Wpointer-arith -Wbad-function-cast -Wcast-qual -Wstrict-prototypes -Wmissing-prototypes -Wmissing-declarations -Wnested-externs'); next arg; };
3247 # An alternate set, from mark@sgcs.com (Mark W. Snitily)
3248 # -Wall -Wstrict-prototypes -Wmissing-prototypes -Wcast-align -Wshadow
3250 # inject "#include <wurble>" into the compiler's C output!
3252 /^-#include(.*)/ && do {
3253 local($to_include) = &grab_arg_arg(*Args,'-#include', $1);
3254 push(@CcInjects, "#include $to_include\n");
3257 #---------- Linker (gcc, really) ---------------------------------------
3259 /^-static$/ && do { push(@Ld_flags, $_); next arg; };
3260 /^-no-hs-main$/ && do { $NoHaskellMain=1; next arg; };
3262 #---------- mixed cc and linker magic ----------------------------------
3263 # this optimisation stuff is finally sorted out later on...
3265 /^-O2-for-C$/ && do { $MinusO2ForC = 1; next arg; };
3267 /^-O[1-2]?$/ && do {
3268 local($opt_lev) = ( /^-O2$/ ) ? 2 : 1; # max 'em
3269 $OptLevel = ( $opt_lev > $OptLevel ) ? $opt_lev : $OptLevel;
3271 $HscOut = '-C=' if $OptLevel == 2; # force use of C compiler
3274 /^-Onot$/ && do { $OptLevel = 0; next arg; }; # # set it to <no opt>
3276 /^-Ofile(.*)/ && do {
3278 local($ofile) = &grab_arg_arg(*Args,'-Ofile', $1);
3279 @HsC_minusO3_flags = ();
3281 open(OFILE, "< $ofile") || die "Can't open $ofile!\n";
3284 s/\#.*//; # death to comments
3285 s/[ \t]+//g; # death to whitespace
3286 next if /^$/; # ditto, blank lines
3287 s/([()*{}])/\\$1/g; # protect shell metacharacters
3289 push(@CcBoth_flags, $1);
3291 push(@HsC_minusO3_flags, $_);
3297 /^-debug$/ && do { # all this does is mark a .hc/.o as "debugging"
3298 # in the consistency info
3302 #---------- linking .a file --------------------------------------------
3304 /^-Main(.*)/ && do {
3305 # specifies main or mainPrimIO to be linked
3309 #---------- catch unrecognized flags -----------------------------------
3312 print STDERR "$Pgm: unrecognised option: $_\n";
3318 } # end of processArgs