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-type-defaults',
291 '-fwarn-name-shadowing',
292 '-fwarn-missing-signatures');
295 What options \tr{-user-setup-a} turn into (user-defined ``packages''
297 of options). Note that a particular user-setup implies a particular
298 Prelude ({\em including} its interface file(s)).
300 $BuildTag = ''; # default is sequential build w/ Appel-style GC
302 %BuildDescr = (# system ways begin
303 '', 'normal sequential',
307 '_mp', "$WAY_mp_NAME",
308 '_mg', "$WAY_mg_NAME",
326 '_B', "$WAY_B_NAME" );
328 # these are options that are "fed back" through the option processing loop
332 '_a', "$WAY_a_HC_OPTS",
333 '_b', "$WAY_b_HC_OPTS",
334 '_c', "$WAY_c_HC_OPTS",
335 '_d', "$WAY_d_HC_OPTS",
336 '_e', "$WAY_e_HC_OPTS",
337 '_f', "$WAY_f_HC_OPTS",
338 '_g', "$WAY_g_HC_OPTS",
339 '_h', "$WAY_h_HC_OPTS",
340 '_i', "$WAY_i_HC_OPTS",
341 '_j', "$WAY_j_HC_OPTS",
342 '_k', "$WAY_k_HC_OPTS",
343 '_l', "$WAY_l_HC_OPTS",
344 '_m', "$WAY_m_HC_OPTS",
345 '_n', "$WAY_n_HC_OPTS",
346 '_o', "$WAY_o_HC_OPTS",
347 '_A', "$WAY_A_HC_OPTS",
348 '_B', "$WAY_B_HC_OPTS",
351 '_p', "$WAY_p_HC_OPTS",
352 '_t', "$WAY_t_HC_OPTS",
353 '_u', "$WAY_u_HC_OPTS",
354 '_mp', "$WAY_mp_HC_OPTS",
355 '_mg', "$WAY_mg_HC_OPTS");
359 Import/include directories (\tr{-I} options) are sufficiently weird to
360 require special handling.
363 @Import_dir = ('.'); #-i things
364 @Include_dir = ('.'); #-I things; other default(s) stuck on AFTER option processing
366 # where to look for interface files (system hi's, i.e., prelude and syslibs)
367 @SysImport_dir = ( $INSTALLING )
368 ? ( "$InstLibDirGhc/imports/std" )
369 : ( "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/std" );
371 # We need to look in ghc/ and glaExts/ when searching for implicitly needed .hi files, but
372 # we should really *not* look there for explicitly imported modules.
374 $Haskell1Version = 5; # i.e., Haskell 1.4
377 # Cpp symbols defined when we're processing Haskell source.
380 ( "-D__HASKELL1__=$Haskell1Version"
381 , "-D__GLASGOW_HASKELL__=$ProjectVersionInt"
384 # , "-D__CONCURRENT_HASKELL__"
387 @UserLibrary_dir= (); #-L things;...
388 @UserLibrary = (); #-l things asked for by the user
390 @SysLibrary_dir = ( ( $INSTALLING ) #-syslib things supplied by the system
392 : ( "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR"
393 , "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR/gmp"
394 , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/std"
395 , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/std/cbits"
398 @SysLibrary = (); # will be built up as we go along
400 $TopClosureFile # defaults to 1.2 one; will be mangled later
402 # ( $INSTALLING) ? "$InstLibDirGhc/TopClosureXXXX.o"
403 # : "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR/main/TopClosureXXXX.o";
405 # make depend for Haskell
407 = ( $INSTALLING ) ? "$InstLibExecDirGhc/mkdependHS"
408 : "$TopPwd/$CURRENT_DIR/$GHC_UTILS_DIR/mkdependHS/mkdependHS";
410 @MkDependHS_flags = ();
412 # do_link flag should not be reset while rescanning the cmd-line.
414 $Specific_output_dir = ''; # set by -odir <dir>
415 $Specific_output_file = ''; # set by -o <file>; "-" for stdout
418 Function to initialise the per-compilation-unit globals that
419 are used to guide and control the invocation of the different phases.
422 sub initDriverGlobals {
424 # reset the following options:
425 # RTS flags to use while compiling
427 @HsP_flags = (); # these are the flags destined solely for
428 # the flex/yacc parser
433 The optimisations/etc to be done by the compiler are {\em normally}
434 expressed with a \tr{-O} (or \tr{-O2}) flag, or by its absence.
437 $OptLevel = 0; # no -O == 0; -O == 1; -O2 == 2; -Ofile == 3
438 $MinusO2ForC = 0; # set to 1 if -O2 should be given to C compiler
439 $StolenX86Regs = 4; # **HACK*** of the very worst sort
443 @Import_dir = ('.'); #-i things
444 @Include_dir = ('.'); #-I things; other default(s) stuck on AFTER option processing
449 We are given a list of files with various presumably-known suffixes
450 (unknown-suffix files go straight to the linker). For each file, we
451 begin by assuming that we'll run every phase over it. However: (1)
452 global flags (\tr{-c}, \tr{-S}, etc.) tell us not to run any phase
453 past a certain point; and (2) the file's suffix tells us what phase to
454 start with. Linking is weird and kept track of separately.
456 Here are the initial defaults applied to all files:
458 $Cpp_flag_set = 0; # (hack)
459 $Only_preprocess_C = 0; # pretty hackish
460 $Only_preprocess_hc = 0; # ditto
461 $Only_generate_deps = 0; # "
462 $PostprocessCcOutput = 0;
465 # static /= 0 => produce code for DLLs (when compiling/linking.)
467 $Static = 0 if ($TargetPlatform =~ /-mingw32$/);
469 # native code-gen or via C?
470 $HaveNativeCodeGen = $GhcWithNativeCodeGen;
471 $HscOut = '-C='; # '-C=' ==> .hc output; '-S=' ==> .s output; '-N=' ==> neither
473 if $HaveNativeCodeGen && $TargetPlatform =~ /^(alpha)-/;
474 # TEMP: disable x86 & Sparc if $HaveNativeCodeGen && $TargetPlatform =~ /^(i386|alpha|sparc)-/;
475 $ProduceHi = '-hifile=';
481 $CollectingGCstats = 0;
482 $CollectGhcTimings = 0;
483 $DEBUGging = ''; # -DDEBUG and all that it entails (um... not really)
484 $PROFing = ''; # set to p or e if profiling
485 $PROFgroup = ''; # set to group if an explicit -Ggroup specified
486 $PROFauto = ''; # set to relevant hsc flag if -auto or -auto-all
487 $PROFcaf = ''; # set to relevant hsc flag if -caf-all
488 $PROFignore_scc = ''; # set to relevant parser flag if explicit sccs ignored
489 $UNPROFscc_auto = ''; # set to relevant hsc flag if forcing auto sccs without profiling
490 $TICKYing = ''; # set to t if compiling for ticky-ticky profiling
491 $PARing = ''; # set to p if compiling for PAR
492 $GRANing = ''; # set to g if compiling for GRAN
493 $Specific_hi_file = ''; # set by -ohi <file>; "-" for stdout
494 $Specific_dump_file = ''; # set by -odump <file>; "-" for stdout
495 $Using_dump_file = 0;
497 $Osuffix = ''; # default: use the normal suffix for that kind of output
499 $HiSuffix_prelude = '';
500 $Do_recomp_chkr = 0; # don't use the recompilatio checker unless asked
501 $Do_cc = -1; # a MAGIC indeterminate value; will be set to 1 or 0.
504 $Keep_hc_file_too = 0;
505 $Keep_s_file_too = 0;
506 $UseGhcInternals = 0; # if 1, may use GHC* modules
508 $DoAsmMangling = 1; # on by default, off by -fno-asm-mangling
510 $Dump_parser_output = 0;
512 $Dump_asm_splitting_info = 0;
513 $NoImplicitPrelude = 0;
514 # 1 => don't tell the linker to hoist in PrelMain.Main, as an
515 # external main is provided instead.
518 } # end of initDriverGlobals (Sigh)
520 # we split the argv passed to the driver into three:
525 # and files to be linked...
531 # cmd line options prefixing the unit we're compiling
536 We inject consistency-checking information into \tr{.hc} files (both
537 when created by the Haskell compiler and when compiled by the C
538 compiler), so that we can check that an executable is made from
539 consistently-built pieces. (The check is normally done just after
540 linking.) The checking is done by introducing/munging
541 \tr{what(1)}-style strings. Anyway, here are the relevant global
542 variables and their defaults:
544 $LinkChk = 0; # set to 0 if the link check should *not* be done
546 # major & minor version numbers; major numbers must always agree;
547 # minor disagreements yield a warning.
548 $HsC_major_version = $HscMajorVersion;
549 $HsC_minor_version = $HscMinorVersion;
550 $Cc_major_version = $CcMajorVersion;
551 $Cc_minor_version = $CcMinorVersion;
553 # options: these must always agree
554 $HsC_consist_options = ''; # we record, in this order:
555 # Build tag; debugging?
556 $Cc_consist_options = ''; # we record, in this order:
557 # Build tag; debugging?
560 %************************************************************************
562 \section[Driver-parse-argv]{Munge the command-line options}
564 %************************************************************************
566 Now slurp through the arguments.
569 &initDriverGlobals();
570 &splitCmdLine(@ARGV);
571 # Run through the cmd-line first time.
572 &processArgs(@Cmd_opts);
574 # Check to see if driver is only in the business
575 # to generate dependencies
576 if ( $Status == 0 && $Only_generate_deps ) {
578 push (@MkDependHS_flags, "-o$Osuffix") if $Osuffix;
579 push (@MkDependHS_flags, "-s$BuildTag") if $BuildTag;
580 # They're not (currently) needed, but we need to quote any -#include options
581 foreach (@Cmd_opts) {
582 s/-#include.*$/'$&'/g;
584 local($to_do) = "$MkDependHS @MkDependHS_flags @HsSourceCppOpts -- @Cmd_opts -- @Input_file" ;
585 &run_something($to_do, 'Haskell dependencies');
589 # if there are several input files,
590 # we don't allow \tr{-o <file>} or \tr{-ohi <file>} options...
591 # (except if linking, of course)
593 if ($#Input_file > 0 && ( ! $Do_lnkr )) {
594 if ( ($Specific_output_file ne '' && $Specific_output_file ne '-')
595 || ($Specific_hi_file ne '' && $Specific_hi_file ne '-') ) {
596 print STDERR "$Pgm: You can't use -o or -ohi options if you have multiple input files.\n";
597 print STDERR "\tPerhaps the -odir option will do what you want.\n";
602 # check for various pathological -o and -odir combinations...
603 if ($Specific_output_dir ne '' && $Specific_output_file ne '') {
604 if ($Specific_output_file eq '-') {
605 print STDERR "$Pgm: can't set output directory with -ohi AND have output to stdout\n";
607 } else { # amalgamate...
608 $Specific_output_file = "$Specific_output_dir/$Specific_output_file";
609 # ToDo: check we haven't got a junk name now...
610 $Specific_output_dir = ''; # reset
614 # crash and burn if there were errors
616 print STDERR $ShortUsage;
621 %************************************************************************
623 \section[Driver-post-argv-mangling]{Setup after reading options}
625 %************************************************************************
627 %************************************************************************
629 \subsection{Set up for optimisation level (\tr{-O} or whatever)}
631 %************************************************************************
633 We come now to the default ``wads of options'' that are turned on by
634 \tr{-O0} (do min optimisation), \tr{-O} (ordinary optimisation),
635 \tr{-O2} (aggressive optimisation), or no O-ish flag (compile speed is
638 The user can also specify his/her own list of options in a file; in
639 that case, the work is already done (see stuff about @minusO3@,
642 GHC allows very precise control of what happens during a compilation.
643 Core-to-Core and STG-to-STG passes can be run in any order, as many
644 times as you like. Individual transformations can be turned on or
647 Sadly, however, there are some interdependencies \& Things You Must
648 Not Do. Here is the list.
652 \item[\tr{-fspecialise}:]
653 The specialiser must have dependency-analysed input; but if you run
654 the simplifier to do this, you must not let it toss away unused
655 bindings! (The typechecker conveys some specialisation info via
656 ``unused'' bindings...)
658 \item[\tr{-ffloat-inwards}:]
659 Floating inwards should be done before strictness analysis, because
660 the latter will give better results.
662 \item[\tr{-fstatic-args}:]
663 The static-arguments-transformation pass {\em must} have the
664 simplifier run right after it.
666 \item[\tr{-fcalc-inlinings[12]}:]
667 Not required, but there may be slight gains by re-simplifying after
668 this is done. (You could then \tr{-fcalc-inlinings} again, just for
671 \item[\tr{-ffull-laziness}:]
672 The (outwards-)let-floater should be the {\em last} Core-to-Core pass
673 that's run. (Um, well, howzabout the simplifier just once more...)
678 \item[\tr{-fupdate-analysis}:]
679 It really really wants to be the last STG-to-STG pass that is run.
684 sub setupOptimiseFlags {
690 '-ffloat-lets-exposing-whnf',
691 '-ffloat-primops-ok',
694 # '-fdo-lambda-eta-expansion', # too complicated
696 # '-flet-to-case', # no strictness analysis, so...
697 $Oopt_PedanticBottoms,
698 # $Oopt_MonadEtaExpansion, # no thanks
700 # These two work fine, if you really want no simplification at all,
701 # for bizarre test reasons. But you get really terrible code if you use them,
702 # for example: let x = e in x
703 # with dozens of redundant thunks etc. So I'm leaving them out.
705 # '-fsimpl-uf-use-threshold0',
706 # '-fessential-unfoldings-only',
709 # The presence of -fclone-binds is *temporary* to work around
710 # the fact that the desugarer in 3.0{2.3} does generate
711 # bindings with identical ids, and the type checker doesn't perform
712 # properly cloned type substitutions. Instead, we make sure that all
713 # binders are cloned first time through the simplifier.
715 # Will be properly fixed in the `new compiler` I hear, at which point
716 # the cloning can be turned off here.
721 $Oopt_MaxSimplifierIterations,
722 $Oopt_ShowSimplifierProgress,
725 # '-ffull-laziness', # removed 95/04 WDP following Andr\'e's lead
727 $Oopt_FinalStgProfilingMassage
730 @HsC_minusO_flags # NOTE: used for *both* -O and -O2 (some conditional bits)
732 '-fdo-eta-reduction',
734 # initial simplify: mk specialiser happy: minimum effort please
738 '-fkeep-spec-pragma-ids', # required before specialisation
740 # I don't understand why we want -fessential-unfoldings-only here
741 # If we have it, the following nasty thing happens:
745 # where "*" means exported.
746 # In the essential-unfoldings pass we still substitute f for g
747 # but we don't substitute E for f first. So we get
751 # The g=f will get reverse-substituted later, but it's untidy. --SLPJ
753 # SDM: Here's why it's necessary.
755 # If we unfold in the first pass before the specialiser is run
756 # we miss opportunities for specialisation because eg. wrappers
757 # have been inlined for specialisable functions.
759 # This shows up in PrelArr.lhs - the specialised instance for newArray
760 # calls the generic rangeSize, because rangeSize is strict and is
761 # replaced by its wrapper by the simplifier.
763 '-fessential-unfoldings-only',
764 '-fsimpl-uf-use-threshold0',
766 # See remark re: cloning in defn of minusnotO
770 '-fmax-simplifier-iterations1',
771 $Oopt_PedanticBottoms,
774 ($Oopt_DoSpecialise) ? (
778 '-fsimplify', # need dependency anal after specialiser ...
779 '[', # need tossing before calc-inlinings ...
781 '-ffloat-lets-exposing-whnf',
782 '-ffloat-primops-ok',
786 # '-fdo-eta-reduction',
787 '-fdo-lambda-eta-expansion',
789 $Oopt_PedanticBottoms,
790 $Oopt_MonadEtaExpansion,
791 $Oopt_MaxSimplifierIterations,
792 $Oopt_ShowSimplifierProgress,
794 # The presence of -fclone-binds is *crucial* here as
795 # -ffull-laziness (which we're about to do next) floats
796 # bindings outwards, so we better make sure that this
797 # doesn't result in the floating out of bindings
798 # with identical uniques, i.e., -ffull-laziness needs
799 # to be preceeded by a simplifier pass with -fclone-binds
804 # ($Oopt_FoldrBuildWW) ? (
805 # '-ffoldr-build-ww-anal',
806 # '-ffoldr-build-worker-wrapper',
810 # '-ffloat-lets-exposing-whnf',
811 # '-ffloat-primops-ok',
815 # '-fdo-eta-reduction',
816 # '-fdo-lambda-eta-expansion',
818 # $Oopt_PedanticBottoms,
819 # $Oopt_MonadEtaExpansion,
820 # $Oopt_MaxSimplifierIterations,
821 # $Oopt_ShowSimplifierProgress,
825 # this pass-ordering sequence was agreed by Simon and Andr\'e
826 # (WDP 94/07, 94/11).
829 ($Oopt_FoldrBuild) ? (
830 '-ffoldr-build-on', # desugar list comprehensions for foldr/build
834 '-fignore-inline-pragma', # **** NB!
835 '-fdo-foldr-build', # NB
837 '-ffloat-lets-exposing-whnf',
838 '-ffloat-primops-ok',
842 # '-fdo-eta-reduction',
843 '-fdo-lambda-eta-expansion', # After full laziness
845 $Oopt_PedanticBottoms,
846 $Oopt_MonadEtaExpansion,
847 $Oopt_MaxSimplifierIterations,
848 $Oopt_ShowSimplifierProgress,
857 '-ffloat-lets-exposing-whnf',
858 '-ffloat-primops-ok',
862 '-fdo-eta-reduction',
863 '-fdo-lambda-eta-expansion',
865 ($Oopt_FoldrBuildInline),
866 # you need to inline foldr and build
867 ($Oopt_FoldrBuild) ? ('-fdo-foldr-build') : (),
868 # but do reductions if you see them!
869 $Oopt_PedanticBottoms,
870 $Oopt_MonadEtaExpansion,
871 $Oopt_MaxSimplifierIterations,
872 $Oopt_ShowSimplifierProgress,
880 '-ffloat-lets-exposing-whnf',
881 '-ffloat-primops-ok',
885 # '-fdo-eta-reduction',
886 '-fdo-lambda-eta-expansion',
888 '-flet-to-case', # Aha! Only done after strictness analysis
889 $Oopt_PedanticBottoms,
890 $Oopt_MonadEtaExpansion,
891 $Oopt_MaxSimplifierIterations,
892 $Oopt_ShowSimplifierProgress,
897 # Case-liberation for -O2. This should be after
898 # strictness analysis and the simplification which follows it.
902 # : "-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 ]" ),
904 # Final clean-up simplification:
909 '-ffloat-lets-exposing-whnf',
910 '-ffloat-primops-ok',
914 # '-fdo-eta-reduction',
915 '-fdo-lambda-eta-expansion',
918 '-fignore-inline-pragma', # **** NB!
919 $Oopt_FoldrBuildInline,
920 ($Oopt_FoldrBuild) ? ('-fdo-foldr-build') : (),
921 # but still do reductions if you see them!
922 $Oopt_PedanticBottoms,
923 $Oopt_MonadEtaExpansion,
924 $Oopt_MaxSimplifierIterations,
925 $Oopt_ShowSimplifierProgress,
930 #LATER: '-fcalc-inlinings2', -- pointless for 2.01
934 $Oopt_FinalStgProfilingMassage,
940 # SPECIAL FLAGS for -O2
942 '-fupdate-analysis', # virtually useless; relegated to -O2
949 Sort out what we're going to do about optimising. First, the @hsc@
950 flags and regular @cc@ flags to worry about:
952 if ( $OptLevel <= 0 ) {
954 # for this level, we tell the parser -fignore-interface-pragmas
955 push(@HsC_flags, '-fignore-interface-pragmas');
956 # and tell the compiler not to produce them
957 push(@HsC_flags, '-fomit-interface-pragmas');
959 &add_Hsc_flags( @HsC_minusNoO_flags );
960 push(@CcBoth_flags, ($MinusO2ForC) ? '-O2' : '-O'); # not optional!
962 } elsif ( $OptLevel == 1 || $OptLevel == 2 ) {
964 &add_Hsc_flags( @HsC_minusO_flags );
965 push(@CcBoth_flags, ($MinusO2ForC || $OptLevel == 2) ? '-O2' : '-O'); # not optional!
966 # -O? to GCC is not optional! -O2 probably isn't worth it generally,
967 # but it *is* useful in compiling the garbage collector.
969 } else { # -Ofile, then...
971 &add_Hsc_flags( @HsC_minusO3_flags );
972 push(@HsC_flags, $Oopt_FinalStgProfilingMassage) if $Oopt_FinalStgProfilingMassage;
974 push(@CcBoth_flags, ($MinusO2ForC) ? '-O2' : '-O'); # possibly to be elaborated...
977 } # setupOptimiseFlags
981 %************************************************************************
983 \subsection{Check for consistency, etc.}
985 %************************************************************************
987 Sort out @$BuildTag@, @$PROFing@, @$PARing@,
988 @$GRANing@, @$TICKYing@:
990 sub setupBuildFlags {
993 # PROFILING stuff after argv mangling:
995 # warn about any scc exprs found (in case scc used as identifier)
996 push(@HsP_flags, '-W');
998 # add -auto sccs even if not profiling !
999 push(@HsC_flags, $UNPROFscc_auto) if $UNPROFscc_auto;
1002 push(@HsC_flags, $PROFauto) if $PROFauto;
1003 push(@HsC_flags, $PROFcaf) if $PROFcaf;
1004 #push(@HsC_flags, $PROFdict) if $PROFdict;
1006 $Oopt_FinalStgProfilingMassage = '-fmassage-stg-for-profiling';
1008 # Ignore user sccs when auto annotating, but warn when doing so.
1009 $PROFignore_scc = '-W' if $PROFauto;
1011 push(@HsP_flags, (($PROFignore_scc) ? $PROFignore_scc : '-S'));
1013 #if ( $BuildTag ne '' ) {
1014 # local($b) = $BuildDescr{$BuildTag};
1015 # if ($PARing eq 'p') { print STDERR "$Pgm: Can't mix $b with -parallel.\n"; exit 1; }
1016 # if ($GRANing eq 'g') { print STDERR "$Pgm: Can't mix $b with -gransim.\n"; exit 1; }
1017 # if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix $b with -ticky.\n"; exit 1; }
1019 # # ok to have a user-way profiling build
1020 # # eval the profiling opts ... but leave user-way BuildTag
1021 # if ($PROFing eq 'p') { &processArgs(split(' ', $SetupOpts{'_p'})); } # eval($EvaldSetupOpts{'_p'}); }
1023 if ( $PROFing eq 'p' ) {
1024 if ($PARing eq 'p') { print STDERR "$Pgm: Can't do profiling with -parallel.\n"; exit 1; }
1025 if ($GRANing eq 'g') { print STDERR "$Pgm: Can't do profiling with -gransim.\n"; exit 1; }
1026 if ($TICKYing eq 't') { print STDERR "$Pgm: Can't do profiling with -ticky.\n"; exit 1; }
1029 } elsif ( $PARing eq 'p' ) {
1030 if ($GRANing eq 'g') { print STDERR "$Pgm: Can't mix -parallel with -gransim.\n"; exit 1; }
1031 if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix -parallel with -ticky.\n"; exit 1; }
1034 if ( $Do_lnkr && ( ! $ENV{'PVM_ROOT'} || ! $ENV{'PVM_ARCH'} )) {
1035 print STDERR "$Pgm: both your PVM_ROOT and PVM_ARCH environment variables must be set for linking under -parallel.\n";
1039 } elsif ( $GRANing eq 'g' ) {
1040 if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix -gransim with -ticky.\n"; exit 1; }
1043 } elsif ( $TICKYing eq 't' ) {
1049 After the sanity checks, add flags to the necessary parts of the driver pipeline:
1052 if ( $BuildTag ne '' ) { # something other than normal sequential...
1054 local($Tag) = "${BuildTag}";
1055 $Tag =~ s/_//; # move the underscore to the back
1057 $HscOut = '-C='; # must go via C
1058 &processArgs(split(' ', $SetupOpts{$BuildTag}));
1059 # eval($EvaldSetupOpts{$BuildTag});
1063 Decide what the consistency-checking options are in force for this run:
1066 $HsC_consist_options = "${BuildTag},${DEBUGging}";
1067 $Cc_consist_options = "${BuildTag},${DEBUGging}";
1070 # Funny place to put it, but why not.
1072 if ( $HiSuffix_prelude eq '' ) {
1073 local($Tag) = "${BuildTag}";
1075 $Tag = "${Tag}_" if $Tag ne '';
1076 $HiSuffix_prelude="${Tag}hi";
1081 %************************************************************************
1083 \subsection{Add on machine-specific C-compiler flags}
1085 %************************************************************************
1087 Shove on magical machine-specific options. We use \tr{unshift} to
1088 stick them on the {\em front} of the arrays, so that ``later''
1089 user-specified flags can clobber them (e.g., \tr{-U__STG_REV_TBLS__}).
1091 Note: a few ``always apply'' flags were set at the very beginning.
1096 if ($TargetPlatform =~ /^alpha-/) {
1097 unshift(@CcBoth_flags, ('-static'));
1099 } elsif ($TargetPlatform =~ /^hppa/) {
1100 unshift(@CcBoth_flags, ('-static'));
1102 # We don't put in '-mlong-calls', because it's only
1103 # needed for very big modules (sigh), and we don't want
1104 # to hobble ourselves further on all the other modules
1107 # [Dated comment (gcc-2.6.x?), -mlong-calls is no longer
1108 # a supported gcc HPPA flag]
1109 unshift(@CcBoth_flags, ('-D_HPUX_SOURCE'));
1110 # ___HPUX_SOURCE, not _HPUX_SOURCE, is #defined if -ansi!
1111 # (very nice, but too bad the HP /usr/include files don't agree.)
1113 } elsif ($TargetPlatform =~ /^i386-/) {
1114 # -fno-defer-pop : basically the same game as for m68k
1116 # -fomit-frame-pointer : *must* in .hc files; because we're stealing
1117 # the fp (%ebp) for our register maps.
1119 unshift(@CcRegd_flags_hc, '-fno-defer-pop');
1120 unshift(@CcRegd_flags_hc, '-fomit-frame-pointer');
1121 unshift(@CcRegd_flags, "-DSTOLEN_X86_REGS=$StolenX86Regs");
1123 } elsif ($TargetPlatform =~ /^m68k-/) {
1124 # -fno-defer-pop : for the .hc files, we want all the pushing/
1125 # popping of args to routines to be explicit; if we let things
1126 # be deferred 'til after an STGJUMP, imminent death is certain!
1128 # -fomit-frame-pointer : *don't*
1129 # It's better to have a6 completely tied up being a frame pointer
1130 # rather than let GCC pick random things to do with it.
1131 # (If we want to steal a6, then we would try to do things
1132 # as on iX86, where we *do* steal the frame pointer [%ebp].)
1134 unshift(@CcRegd_flags_hc, '-fno-defer-pop');
1135 unshift(@CcRegd_flags, '-fno-omit-frame-pointer');
1136 # maybe gives reg alloc a better time
1137 # also: -fno-defer-pop is not sufficiently well-behaved without it
1139 } elsif ($TargetPlatform =~ /^mips-/) {
1140 unshift(@CcBoth_flags, ('-static'));
1142 } elsif ($TargetPlatform =~ /^powerpc-|^rs6000-/) {
1143 unshift(@CcBoth_flags, ('-static')); # always easier to start with
1144 unshift(@CcRegd_flags, ('-finhibit-size-directive')); # avoids traceback tables
1145 } elsif ($TargetPlatform =~ /^sparc-/) {
1147 } # end of setupMachOpts
1150 %************************************************************************
1152 \subsection{Set up for warnings}
1154 %************************************************************************
1156 Several warnings are turned on by default. These are supposed to be
1157 the 'I'm pretty sure you've made a mistake here' kind of warnings.
1158 The rest are turned on by the -W and -Wall options, or individually
1159 via their -fwarn and -fno-warn flags.
1162 sub setupWarningFlags {
1163 &add_Hsc_flags( @StandardWarnings );
1167 Same unshifting magic, but for special linker flags.
1169 The configure script determines whether the object file symbol tables
1170 have a leading underscore, and sets @LeadingUnderscore@ accordingly.
1171 (The driver script `sees' the setting of the @LeadingUnderscore@
1172 by having the Makefile prepend it).
1176 local($uscore) = ( ${LeadingUnderscore} eq 'YES' ) ? '_' : '';
1179 (($Ld_main) ? ( '-u', "${uscore}Main_" . $Ld_main . '_closure' ) : ()));
1181 # things that are referenced by the RTS - make sure that we pull 'em in
1183 ( '-u', "${uscore}PrelBase_Izh_static_info"
1184 ,'-u', "${uscore}PrelBase_Czh_static_info"
1185 ,'-u', "${uscore}PrelBase_Fzh_static_info"
1186 ,'-u', "${uscore}PrelBase_Dzh_static_info"
1187 ,'-u', "${uscore}PrelAddr_Azh_static_info"
1188 ,'-u', "${uscore}PrelAddr_Wzh_static_info"
1189 ,'-u', "${uscore}PrelAddr_I64zh_static_info"
1190 ,'-u', "${uscore}PrelAddr_W64zh_static_info"
1191 ,'-u', "${uscore}PrelStable_StablePtr_static_info"
1192 ,'-u', "${uscore}PrelBase_Izh_con_info"
1193 ,'-u', "${uscore}PrelBase_Czh_con_info"
1194 ,'-u', "${uscore}PrelBase_Fzh_con_info"
1195 ,'-u', "${uscore}PrelBase_Dzh_con_info"
1196 ,'-u', "${uscore}PrelAddr_Azh_con_info"
1197 ,'-u', "${uscore}PrelAddr_Wzh_con_info"
1198 ,'-u', "${uscore}PrelAddr_I64zh_con_info"
1199 ,'-u', "${uscore}PrelAddr_W64zh_con_info"
1200 ,'-u', "${uscore}PrelStable_StablePtr_con_info"
1201 ,'-u', "${uscore}PrelBase_False_static_closure"
1202 ,'-u', "${uscore}PrelBase_True_static_closure"
1203 ,'-u', "${uscore}PrelPack_unpackCString_closure"
1205 if (!$NoHaskellMain) {
1206 unshift (@Ld_flags,'-u', "${uscore}PrelMain_mainIO_closure");
1208 if ($TargetPlatform =~ /^powerpc-|^rs6000-/) {
1209 # sometimes we have lots of toc entries...
1210 # unshift(@Ld_flags, ('-Xlinker -bbigtoc -Xlinker -bnoquiet'));
1211 unshift(@Ld_flags, ('-Xlinker -bbigtoc'));
1215 } # end of setupLinkOpts
1219 %************************************************************************
1221 \subsection{Set up include paths and system-library enslurpment}
1223 %************************************************************************
1225 Now that we know what garbage-collector, etc., are required, we can
1226 finalise our list of libraries to slurp through, and generally Get
1231 # default includes must be added AFTER option processing
1232 if ( ! $INSTALLING ) {
1233 push (@Include_dir, "$TopPwd/${CURRENT_DIR}/${GHC_INCLUDE_DIR}");
1235 push (@Include_dir, "$InstLibDirGhc/includes");
1236 push (@Include_dir, "$InstLibDirGhc/includes");
1238 } # end of setupIncPaths
1243 push(@SysLibrary, ( '-lHS', '-lHS_cbits' )); # basic I/O and prelude stuff
1246 foreach $f (@SysLibrary) {
1247 next if $f =~ /_cbits/;
1248 $f .= $BuildTag if $f =~ /^-lHS/;
1251 # Push library HSrts, plus boring clib bit
1252 push(@SysLibrary, "-lHSrts${BuildTag}");
1255 # RTS compiled with cygwin32, uses the WinMM API
1256 # to implement the itimers, since cygwin.dll does not
1257 # support it. Only reqd. for `ways' that use itimers.
1259 push(@SysLibrary, '-lwinmm') if $TargetPlatform eq 'i386-unknown-cygwin32';
1261 # Push the pvm libraries
1262 if ($BuildTag eq '_mp') {
1263 $pvmlib = "$ENV{'PVM_ROOT'}/lib/$ENV{'PVM_ARCH'}";
1264 push(@SysLibrary, "-L$pvmlib", '-lgpvm3', '-lpvm3');
1265 if ( $ENV{'PVM_ARCH'} eq 'SUNMP' ) {
1266 push(@SysLibrary, '-lthread', '-lsocket', '-lnsl');
1267 } elsif ( $ENV{'PVM_ARCH'} eq 'SUN4SOL2' ) {
1268 push(@SysLibrary, '-lsocket', '-lnsl');
1272 # Push the GNU multi-precision arith lib; and the math library
1274 # If this machine has GMP already installed, then we'll get the installed
1275 # lib here, because presumably the one in the tree won't have been built.
1277 if ($LibGmp eq 'not-installed') {
1278 push(@SysLibrary, "-lgmp");
1280 push(@SysLibrary, "-l$LibGmp");
1283 push(@SysLibrary, '-lm') if !( $TargetPlatform =~ /^.*(cygwin32|mingw32)$/ );
1286 %************************************************************************
1288 \subsection{Check that this system was built to do what we are asking}
1290 %************************************************************************
1292 Before continuing we check that the appropriate build is available.
1295 #die "$Pgm: no BuildAvail?? $BuildTag\n" if $BuildDescr{$BuildTag} eq '' ; # sanity
1297 if ( $BuildDescr{$BuildTag} eq '' ) {
1298 print STDERR "$Pgm: a `", $BuildDescr{$BuildTag},
1299 "' \"build\" is not available with your GHC setup.\n";
1300 print STDERR "(It was not configured for it at your site.)\n";
1301 print STDERR $ShortUsage;
1305 } # end of setupSyslibs
1309 %************************************************************************
1311 \subsection{Final miscellaneous setup bits before we start going}
1313 %************************************************************************
1315 Record largest specific heapsize, if any.
1317 sub setupHeapStackSize {
1318 $Specific_heap_size = $Specific_heap_size * $Scale_sizes_by;
1319 push(@HsC_rts_flags, '-H'.$Specific_heap_size);
1320 $Specific_stk_size = $Specific_stk_size * $Scale_sizes_by;
1321 push(@HsC_rts_flags, "-K$Specific_stk_size");
1325 If no input or link files seen, then we let 'em feed in stdin; this is
1326 mainly for debugging.
1330 if ($#Input_file < 0 && $#Link_file < 0) {
1331 @Input_file = ( '-' );
1333 open(INF, "> $Tmp_prefix.hs") || &tidy_up_and_die(1,"Can't open $Tmp_prefix.hs\n");
1334 print STDERR "Enter your Haskell program, end with ^D (on a line of its own):\n" if -t;
1335 while (<STDIN>) { print INF $_; }
1336 close(INF) || &tidy_up_and_die(1,"Failed writing to $Tmp_prefix.hs\n");
1341 Tell the world who we are, if they asked.
1343 print STDERR "${ProjectName}, version ${ProjectVersion}, patchlevel ${ProjectPatchLevel}\n"
1347 %************************************************************************
1349 \section[Driver-main-loop]{Main loop: Process input files, and link if required}
1351 %************************************************************************
1353 Process the input files; don't continue with linking if there are
1354 problems (global variable @$Status@ non-zero).
1356 foreach $ifile (@Input_file) {
1357 &ProcessInputFile($ifile);
1360 if ( $Status > 0 ) { # don't link if there were errors...
1361 print STDERR $ShortUsage;
1366 # append last minute flags linker and consistency flags
1373 Link if appropriate.
1376 local($libdirs) = '';
1378 # glue them together:
1379 push(@UserLibrary_dir, @SysLibrary_dir);
1381 $libdirs = '-L' . join(' -L',@UserLibrary_dir) if $#UserLibrary_dir >= 0;
1383 # for a linker, use an explicitly given one, or the going C compiler ...
1384 local($lnkr) = ( $Lnkr ) ? $Lnkr : $CcRegd;
1386 if ( ($Specific_output_file eq '') &&
1387 ($TargetPlatform eq 'i386-unknown-cygwin32') ) {
1388 $Specific_output_file = 'main.exe';
1389 print STDERR "Output file not specified, defaulting to \"main.exe\"\n";
1392 local($output) = ($Specific_output_file ne '') ? "-o $Specific_output_file" : '';
1393 @Files_to_tidy = ($Specific_output_file ne '') ? $Specific_output_file : 'a.out';
1396 # Win32 DLLs - link with import libraries, not the real archives.
1398 if ( $TargetPlatform =~ /-mingw32$/ && !$Static ) {
1399 foreach $a ( @SysLibrary ) {
1400 next if ($a eq '-lm');
1401 $a = "${a}_imp" if ($a =~ /^-l/);
1403 push(@Link_file, ( $INSTALLING ) ? "$InstLibDirGhc/Main.o"
1404 : "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR/Main.o");
1405 push(@Link_file, ( $INSTALLING ) ? "$InstLibDirGhc/PrelMain.o"
1406 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/PrelMain.o");
1407 push(@Ld_flags, "-mno-cygwin");
1409 local($to_do) = "$lnkr $Verbose @Ld_flags $output @Link_file $TopClosureFile $libdirs @UserLibrary @SysLibrary";
1410 &run_something($to_do, 'Linker');
1412 # finally, check the consistency info in the binary
1413 local($executable) = $Files_to_tidy[0];
1414 @Files_to_tidy = (); # reset; we don't want to nuke it if it's inconsistent
1417 # dynamically load consistency-chking code; then do it.
1418 require('ghc-consist.prl')
1419 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-consist.prl!\n");
1421 &chk_consistency_info ( $executable );
1424 # if PVM parallel stuff, we do truly weird things.
1425 # Essentially: (1) move the executable over to where PVM expects
1426 # to find it. (2) create a script in place of the executable
1427 # which will cause the program to be run, via SysMan.
1428 if ( $PARing eq 'p' ) {
1429 local($pvm_executable) = $executable;
1430 local($pvm_executable_base);
1432 if ( $pvm_executable !~ /^\// ) { # a relative path name: make absolute
1433 local($pwd) = `pwd`;
1435 $pwd =~ s/^\/tmp_mnt//;
1436 $pvm_executable = "$pwd/$pvm_executable";
1439 $pvm_executable =~ s|/|=|g; # make /s into =s
1440 $pvm_executable_base = $pvm_executable;
1442 $pvm_executable = $ENV{'PVM_ROOT'} . '/bin/' . $ENV{'PVM_ARCH'}
1443 . "/$pvm_executable";
1445 &run_something("$Rm -f $pvm_executable; $Cp -p $executable $pvm_executable && $Rm -f $executable", 'Moving binary to PVM land');
1447 # OK, now create the magic script for "$executable"
1448 open(EXEC, "> $executable") || &tidy_up_and_die(1,"$Pgm: couldn't open $executable to write!\n");
1449 print EXEC <<EOSCRIPT1;
1450 eval 'exec perl -S \$0 \${1+"\$@"}'
1451 if \$running_under_some_shell;
1452 # =!=!=!=!=!=!=!=!=!=!=!
1453 # This script is automatically generated: DO NOT EDIT!!!
1454 # Generated by Glasgow Haskell, version ${ProjectVersion} ${ProjectPatchLevel}
1456 \$pvm_executable = '$pvm_executable';
1457 \$pvm_executable_base = '$pvm_executable_base';
1458 \$SysMan = '$SysMan';
1461 print EXEC <<\EOSCRIPT2;
1462 # first, some magical shortcuts to run "commands" on the binary
1464 if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {
1466 system("$cmd $pvm_executable");
1470 # OK, really run it; process the args first
1471 $ENV{'PE'} = $pvm_executable_base;
1473 $nprocessors = 2; # the default
1477 # ToDo: handle --RTS
1478 args: while ($a = shift(@ARGV)) {
1479 if ( $a eq '+RTS' ) {
1481 } elsif ( $a eq '-RTS' ) {
1484 if ( $a eq '-d' && $in_RTS_args ) {
1486 } elsif ( $a =~ /^-N(\d+)/ && $in_RTS_args ) {
1489 push(@nonPVM_args, $a);
1493 local($return_val) = 0;
1494 system("$SysMan $debug $pvm_executable $nprocessors @nonPVM_args");
1496 system("mv $ENV{'HOME'}/$pvm_executable_base.???.gr .") if -f "$ENV{'HOME'}/$pvm_executable_base.001.gr";
1499 close(EXEC) || die "Failed closing $executable\n";
1500 chmod 0755, $executable;
1504 # that... that's all, folks!
1506 exit $Status; # will still be 0 if all went well
1509 %************************************************************************
1511 \section[Driver-do-one-file]{How to process a single input file}
1513 %************************************************************************
1516 sub ProcessInputFile {
1517 local($ifile) = @_; # input file name
1518 local($ifile_root); # root of or basename of input file
1519 local($ofile_target); # ultimate output file we hope to produce
1520 # from input file (need to know for recomp
1521 # checking purposes)
1522 local($hifile_target);# ditto (but .hi file)
1523 local($ofile_c_stub_target);
1524 local($ofile_h_stub_target);
1527 Handle the weirdity of input from stdin.
1529 if ($ifile ne '-') {
1530 ($ifile_root = $ifile) =~ s/\.[^\.\/]+$//;
1531 $ofile_target = # may be reset later...
1532 ($Specific_output_file ne '' && ! $Do_lnkr)
1533 ? $Specific_output_file
1534 : &odir_ify($ifile_root, 'o');
1535 $hifile_target= ($Specific_hi_file ne '')
1537 : "$ifile_root.$HiSuffix"; # ToDo: odirify?
1538 # NB: may change if $ifile_root isn't module name (??)
1539 ($ofile_c_stub_target = $ifile) =~s/\.[^\.\/]+$/_stub.c/;
1540 ($ofile_h_stub_target = $ifile) =~s/\.[^\.\/]+$/_stub.h/;
1542 $ifile = "$Tmp_prefix.hs"; # we know that's where we put the input
1543 $ifile_root = '_stdin';
1544 $ofile_target = '_stdout'; # gratuitous?
1545 $hifile_target= '_stdout'; # ditto?
1549 We need to decide what phases of the compilation system we will run
1550 over this file. The defaults are the ones established when processing
1551 flags. (That established what the last phase run for all files is.)
1553 We do the pre-recompilation-checker phases here; the rest later.
1557 Look at the suffix and decide what initial phases of compilation may
1558 be dropped off for this file. Also the rather boring business of
1559 which files are coming-in/going-out.
1561 Again, we'll do the post-recompilation-checker parts of this later.
1563 local($do_lit2pgm) = ($ifile =~ /\.lhs$/) ? 1 : 0;
1564 local($do_hscpp) = 1; # but "hscpp" might really be "cat"
1567 # names of the files to stuff between phases
1568 # defaults are temporaries
1569 local($in_lit2pgm) = $ifile;
1570 local($lit2pgm_hscpp) = "$Tmp_prefix.lpp";
1571 local($hscpp_hsc) = "$Tmp_prefix.cpp";
1572 local($hsc_hi) = "$Tmp_prefix.hi";
1573 local($cc_as_o) = "${Tmp_prefix}_o.s"; # temporary for raw .s file if opt C
1574 local($cc_as) = "$Tmp_prefix.s"; # mangled or hsc-produced .s code
1575 local($as_out) = $ofile_target;
1577 local($is_hc_file) = 1; #Is the C code .hc or .c? Assume .hc for now
1579 # OK, let's strip off some literate junk..
1581 &runLit2pgm($in_lit2pgm, $lit2pgm_hscpp)
1583 $lit2pgm_hscpp = $ifile;
1589 # Scan the top of the de-litted file for {-# OPTIONS #-} pragmas
1590 &check_for_source_options($lit2pgm_hscpp,$ifile);
1592 # Options found in the source file take a back seat, i.e., we scan
1593 # them first. Only process the command line again if source file
1594 # contained anything of interest *or* there's more than one
1595 # input file (we have to reset the options).
1597 if ( $#Input_file >= 0 || $#File_options >= 0) {
1598 #@File_options = (@File_options, @Cmd_opts);
1600 # Now process the command line
1601 &initDriverGlobals();
1602 &processArgs((@File_options,@Cmd_opts));
1603 print STDERR "\nEffective command line: " .
1604 join(' ',(@File_options,@Cmd_opts)) . "\n" if $Verbose;
1607 # Having got the effective command line scanned, set up
1608 # the various options in prep for some real work.
1610 # check the sanity of the BuildTag we're about to use,
1611 # and if needs be, add some more flags and setup to
1612 # the different phases.
1615 &setupOptimiseFlags();
1618 &setupWarningFlags();
1619 &setupHeapStackSize();
1622 # These two variables need to be set after the
1623 # command-line has been processed and the build options
1624 # have be seen set up. This is because command-line options
1625 # can control whether to compile vias C or not.
1627 local($do_cc) = ( $Do_cc != -1) # i.e., it was set explicitly
1629 : ( ($HscOut eq '-C=') ? 1 : 0 );
1630 local($do_as) = $Do_as;
1631 local($hsc_out) = ( $HscOut eq '-C=' ) ? "$Tmp_prefix.hc" : "$Tmp_prefix.s" ;
1632 local($hsc_out_c_stub) = ( $HscOut eq '-C=' ) ? "${Tmp_prefix}_stb.c" : "";
1633 local($hsc_out_h_stub) = ( $HscOut eq '-C=' ) ? "${Tmp_prefix}_stb.h" : "";
1635 if ($Only_preprocess_hc) { # stop after having run $Cc -E
1638 if ($Only_preprocess_C) { # stop after having run $hscpp
1639 $do_hsc=0; $do_cc = 0; $do_as=0;
1640 } elsif ($ifile =~ /.lhs$/ || $ifile =~ /.hs$/ ) {
1642 } elsif ($ifile =~ /\.hc$/ || $ifile =~ /_hc$/ ) { # || $ifile =~ /\.$Isuffix$/o) # ToDo: better
1643 $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
1645 $hsc_out_c_stub = '';
1646 $hsc_out_h_stub = '';
1647 } elsif ($ifile =~ /\.c$/) {
1648 $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
1649 $hsc_out = $ifile; $is_hc_file = 0;
1650 $hsc_out_c_stub = '';
1651 $hsc_out_h_stub = '';
1652 } elsif ($ifile =~ /\.[sS]$/) {
1653 $do_hscpp = 0; $do_hsc = 0; $do_cc = 0;
1655 } else { # don't know what it is, but nothing to do herein...
1656 $do_hscpp = 0; $do_hsc = 0; $do_cc = 0; $do_as = 0;
1659 # hack to avoid running hscpp
1660 $HsCpp = $Cat if ! $Cpp_flag_set;
1662 &runHscpp($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc) if $do_hscpp;
1666 We now think about whether to run hsc/cc or not (when hsc produces .s
1667 stuff, it effectively takes the place of both phases).
1668 To get the output file name right: for each phase that we are {\em
1669 not} going to run, set its input (i.e., the output of its preceding
1670 phase) to @"$ifile_root.<suffix>"@.
1673 local($going_interactive) = $HscOut eq '-N=' || $ifile_root eq '_stdin';
1676 # Warning issued if -keep-hc-file-too is used without
1677 # -fvia-C (or the equivalent)
1679 if ( $HscOut ne '-C=' && $Keep_hc_file_too ) {
1680 print STDERR "$Pgm: warning: Native code generator to be used, -keep-hc-file-too will be ignored\n";
1683 if (! $do_cc && ! $do_as) { # stopping after hsc
1684 $hsc_out = ($Specific_output_file ne '')
1685 ? $Specific_output_file
1686 : &odir_ify($ifile_root, ($HscOut eq '-C=') ? 'hc' : 's');
1688 $ofile_target = $hsc_out; # reset
1691 if (! $do_as) { # stopping after gcc (or hsc)
1692 $cc_as = ($Specific_output_file ne '')
1693 ? $Specific_output_file
1694 : &odir_ify($ifile_root, ( $Only_preprocess_hc ) ? 'i' : 's');
1696 $ofile_target = $cc_as; # reset
1702 Now the Haskell compiler, C compiler, and assembler
1706 &runHscAndProcessInterfaces( $ifile, $hscpp_hsc, $ifile_root,
1707 $ofile_target, $hifile_target,
1708 $going_interactive);
1711 if (-f $hsc_out_h_stub) {
1712 &run_something("cp $hsc_out_h_stub $ofile_h_stub_target", 'Copy foreign export header file');
1715 if (-f $hsc_out_c_stub) {
1716 &run_something("cp $hsc_out_c_stub $ofile_c_stub_target", 'Copy foreign export C stubs');
1717 local ($hsc_out_s_stub);
1718 local ($hsc_out_o_stub);
1719 ($ofile_s_stub_target = $ofile_c_stub_target) =~ s/\.(.*)$/\.s/;
1720 ($ofile_o_stub_target = $ofile_c_stub_target) =~ s/\.(.*)$/\.o/;
1721 &runGcc (0, $ofile_c_stub_target, $ofile_s_stub_target);
1722 &runAs ($ofile_o_stub_target, $ofile_s_stub_target);
1724 # Bring the C stub protos into scope when compiling the .hc file.
1726 push (@CcInjects, "#include \"${hsc_out_h_stub}\"\n");
1727 # Hack - ensure that the stub .h file is included in the OPTIONS section
1728 # if the .hc file is saved.
1729 push (@File_options, "-#include \"${ofile_h_stub_target}\"\n");
1734 &runGcc ($is_hc_file, $hsc_out, $cc_as_o);
1735 &runMangler($is_hc_file, $cc_as_o, $cc_as, $ifile_root) if ! $Only_preprocess_hc;
1738 &split_asm_file($cc_as) if $do_as && $SplitObjFiles;
1740 # save a copy of the .s file..
1741 &saveIntermediate($ifile_root , "s" , $cc_as) if ($do_as && $Keep_s_file_too);
1742 &runAs($as_out, $ifile_root) if $do_as;
1745 Finally, decide what to queue up for linker input.
1747 # tentatively assume we will eventually produce linker input:
1748 push(@Link_file, &odir_ify($ifile_root, 'o'));
1750 #ToDo: local($or_isuf) = ($Isuffix eq '') ? '' : "|$Isuffix";
1752 if ( $ifile !~ /\.(lhs|hs|hc|c|s|a|S)$/ && $ifile !~ /_hc$/ ) {
1753 # There's sometimes confusion regarding .hi files; users
1754 # supplying them on the command line.
1755 if ( $ifile =~ /\.hi$/ ) {
1756 print STDERR "$Pgm: warning: found `$ifile' on command line; interface files should not be supplied here - ignoring it.\n";
1758 print STDERR "$Pgm: don't recognise suffix on `$ifile'; passing it through to linker\n";
1760 # oops; we tentatively pushed the wrong thing; fix & do the right thing
1761 pop(@Link_file); push(@Link_file, $ifile);
1765 } # end of ProcessInputFile
1768 %************************************************************************
1770 \section[Driver-run-phases]{Routines to run the various phases}
1772 %************************************************************************
1776 local($in_lit2pgm, $lit2pgm_hscpp) = @_;
1780 # Only add #line pragma if we're going to need it.
1781 $to_do = "echo '#line 1 \"$in_lit2pgm\"' > $lit2pgm_hscpp && " if ($Cpp_flag_set);
1782 $to_do .= "$Unlit @Unlit_flags $in_lit2pgm - >> $lit2pgm_hscpp";
1784 push(@Files_to_tidy, $lit2pgm_hscpp );
1786 &run_something($to_do, 'literate pre-processor');
1792 local($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc) = @_;
1796 # Strictly speaking, echoing of the following line pragma is only required
1797 # on non-delit'ed input, as we've already added it during de-lit. However,
1798 # hscpp will then add a {-# LINE 1 "$lit2pgm_hsc" -} to the top of the file,
1799 # which is not very informative (but harmless). Hence, we uniformly have
1800 # {-# LINE 1 "$in_lit2pgm" #-} as the first line to all cpp'ed hsc input.
1802 $to_do = "echo '{-# LINE 1 \"$in_lit2pgm\" -}' > $hscpp_hsc && ";
1804 if ($HsCpp eq $Cat) {
1805 $to_do .= "$HsCpp $lit2pgm_hscpp >> $hscpp_hsc";
1806 push(@Files_to_tidy, $hscpp_hsc );
1807 &run_something($to_do, 'Ineffective C pre-processor');
1809 local($includes) = '-I' . join(' -I',@Include_dir);
1810 $to_do .= "$HsCpp $Verbose @HsCpp_flags @HsSourceCppOpts $includes $lit2pgm_hscpp >> $hscpp_hsc";
1811 push(@Files_to_tidy, $hscpp_hsc );
1812 &run_something($to_do, 'Haskellised C pre-processor');
1815 if ( $Only_preprocess_C ) {
1816 $to_do = "$Cat $hscpp_hsc";
1817 &run_something($to_do, '');
1825 sub runHscAndProcessInterfaces {
1826 local($ifile, $hscpp_hsc, $ifile_root,
1827 $ofile_target, $hifile_target,
1828 $going_interactive) = @_;
1830 # $ifile is the original input file
1831 # $hscpp_hsc post-unlit, post-cpp, etc., input file
1832 # $ifile_root input filename minus suffix
1833 # $ofile_target the output file that we ultimately hope to produce
1834 # $hifile_target the .hi file ... (ditto)
1836 local($source_unchanged) = 1;
1838 # Check if the source file is up to date relative to the target; in
1839 # that case we say "source is unchanged" and let the compiler bail out
1840 # early if the import usage information allows it.
1842 ($i_dev,$i_ino,$i_mode,$i_nlink,$i_uid,$i_gid,$i_rdev,$i_size,
1843 $i_atime,$i_mtime,$i_ctime,$i_blksize,$i_blocks) = stat($ifile);
1845 # The informational messages below are now conditional on -v being set -- SOF
1846 if ( $ofile_target ne "_stdin.s" && ! -f $ofile_target ) {
1847 print STDERR "$Pgm:compile:Output file $ofile_target doesn't exist\n" if $Verbose;
1848 $source_unchanged = 0;
1851 ($o_dev,$o_ino,$o_mode,$o_nlink,$o_uid,$o_gid,$o_rdev,$o_size,
1852 $o_atime,$o_mtime,$o_ctime,$o_blksize,$o_blocks) = stat(_); # stat info from -f test
1854 if ( $hifile_target ne "_stdout" && ! -f $hifile_target ) {
1855 print STDERR "$Pgm:compile:Interface file $hifile_target doesn't exist\n" if $Verbose;
1856 $source_unchanged = 0;
1859 ($hi_dev,$hi_ino,$hi_mode,$hi_nlink,$hi_uid,$hi_gid,$hi_rdev,$hi_size,
1860 $hi_atime,$hi_mtime,$hi_ctime,$hi_blksize,$hi_blocks) = stat(_); # stat info from -f test
1862 if ( $ofile_target ne "_stdin.s" && $i_mtime > $o_mtime) {
1863 print STDERR "$Pgm:recompile:Input file $ifile newer than $ofile_target\n" if $Verbose;
1864 $source_unchanged = 0;
1867 # Tell the compiler which version we're using
1868 push(@HsC_flags, "-fhi-version=${ProjectVersionInt}");
1870 # So if source_unchanged is still "1", we pass on the good news to the compiler
1871 # The -recomp flag can disable this, forcing recompilation
1872 if ($Do_recomp_chkr && $source_unchanged) {
1873 push(@HsC_flags, '-fsource-unchanged');
1876 # Indicate whether we're static or not.
1877 # This will only ever
1878 push(@HsC_flags, '-static') if $Static;
1882 &runHsc($ifile_root, $hsc_out, $hsc_hi, $hsc_out_c_stub, $hsc_out_h_stub, $going_interactive);
1884 # See if it bailed out early, saying nothing needed doing.
1885 # We work this out by seeing if it created an output .hi file
1887 if ( ! -f $hsc_hi && $ProduceHi !~ /-nohifile=/ ) {
1888 # Doesn't exist, so we bailed out early.
1889 # Tell the C compiler and assembler not to run
1890 $do_cc = 0; $do_as = 0;
1892 # Update dependency info, touch both object file and
1893 # interface file, so that the following invariant is
1896 # a dependent module's interface file should after recompilation
1897 # checking be newer than the interface files of its imports.
1899 # That is, if module A's interface file changes, then module B
1900 # (which import from A) needs to be checked.
1901 # If A's change does not affect B, which causes the compiler to bail
1902 # out early, we still need to touch the interface file of B. The reason
1903 # for this is that B may export A's interface.
1905 &run_something("touch $ofile_target",
1906 "Touch $ofile_target, to propagate dependencies") if $HscOut ne '-N=';
1907 &run_something("touch $hifile_target",
1908 "Touch $hifile_target, to propagate dependencies") if $ProduceHi =~ /-nohifile=/ ;
1912 # Didn't bail out early (new .hi file) so we thunder on
1914 # If non-interactive, heave in the consistency info at the end
1915 # NB: pretty hackish (depends on how $output is set)
1916 if ( ! $going_interactive ) {
1917 if ( $HscOut eq '-C=' ) {
1918 $to_do = "echo 'static char ghc_hsc_ID[] = \"\@(#)hsc $ifile\t$HsC_major_version.$HsC_minor_version,$HsC_consist_options\";' >> $hsc_out";
1920 } elsif ( $HscOut eq '-S=' ) {
1921 local($consist) = "hsc.$ifile.$HsC_major_version.$HsC_minor_version.$HsC_consist_options";
1922 $consist =~ s/,/./g;
1923 $consist =~ s/\//./g;
1924 $consist =~ s/-/_/g;
1925 $consist =~ s/[^A-Za-z0-9_.]/ZZ/g; # ToDo: properly?
1926 $to_do = "echo '\n\t.text\n$consist:' >> $hsc_out";
1928 &run_something($to_do, 'Pin on Haskell consistency info');
1932 # Interface-handling is important enough to live off by itself
1933 if ( $ProduceHi !~ /-nohifile=/ ) { # If we've produced one, process it.
1934 require('ghc-iface.prl') || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-iface.prl!\n");
1935 &postprocessHiFile($hsc_hi, $hifile_target, $going_interactive);
1937 # if we're going to split up object files,
1938 # we inject split markers into the .hc file now
1939 if ( $HscOut eq '-C=' && $SplitObjFiles ) {
1940 &inject_split_markers ( $hsc_out );
1943 # save a copy of the .hc file, even if we are carrying on...
1944 if ($HscOut eq '-C=' && $do_cc && $Keep_hc_file_too) {
1945 &saveIntermediate($ifile_root , "hc" , $hsc_out);
1955 local($ifile_root, $hsc_out, $hsc_hi, $hsc_out_c_stub, $hsc_out_h_stub, $going_interactive) = @_;
1957 # prepend comma to HsP flags (so hsc can tell them apart...)
1958 foreach $a ( @HsP_flags ) { $a = ",$a" unless $a =~ /^,/; }
1960 &makeHiMap() unless $HiMapDone;
1961 push(@HsC_flags, "-himap=$HiIncludeString");
1963 # here, we may produce .hc/.s and/or .hi files
1964 local($output) = '';
1965 #@Files_to_tidy = ();
1967 if ( $going_interactive ) {
1968 # don't need .hi unless we're going to show it on stdout:
1969 $ProduceHi = '-nohifile=' if ! ($HiOnStdout || $Specific_hi_file ne '' );
1970 $do_cc = 0; $do_as = 0; $Do_lnkr = 0; # and we won't go any further...
1973 # set up for producing output/.hi; note that flag twiddling
1974 # may mean that nothing will actually be produced:
1975 $output = "$ProduceHi$hsc_hi $HscOut$hsc_out -F=$hsc_out_c_stub -FH=$hsc_out_h_stub";
1976 push(@Files_to_tidy, $hsc_hi, $hsc_out, $hsc_out_c_stub, $hsc_out_h_stub );
1978 # if we're compiling foo.hs, we want the GC stats to end up in foo.stat
1979 if ( $CollectingGCstats ) {
1980 push(@HsC_rts_flags, "-S$ifile_root.stat");
1981 push(@Files_to_tidy, "$ifile_root.stat");
1984 if ( $CollectGhcTimings ) { # assume $RTS_style eq 'ghc'
1985 # emit nofibbish time/bytes-alloc stats to stderr;
1986 # see later .stat file post-processing
1987 print STDERR "warning: both -Rgc-stats and -Rghc-timing used, -Rghc-timing wins." if $CollectingGCstats;
1988 push(@HsC_rts_flags, "-s$Tmp_prefix.stat");
1989 push(@Files_to_tidy, "$Tmp_prefix.stat");
1993 if ($Specific_dump_file ne '') {
1994 $dump = "2>> $Specific_dump_file";
1995 $Using_dump_file = 1;
1999 # Win32 only: If the command processor used by system()
2000 # exec()s the application as an ordinary Win32 executable,
2001 # we're in trouble here, since the command line is likely
2002 # to be > 255 chars long. To work around this situation,
2003 # $HsC also understands `at-files', i.e., `@file' on the
2004 # command line will cause $HsC to add the contents of `file'
2005 # to the command line.
2007 # [ Note: support for `at-files' is not compiled in by default ]
2008 $cmd_line_opts_via_at_file=0;
2009 if ($cmd_line_opts_via_at_file) {
2011 local($to_do_opts) = "$Tmp_prefix.opts";
2012 open(OPTS, "> $Tmp_prefix.opts") || &tidy_up_and_die(1,"Can't open $Tmp_prefix.opts\n");
2013 print OPTS "$dump @HsC_flags $CoreLint $StgLint $Verbose";
2015 $to_do = "$HsC @HsP_flags ,$hscpp_hsc \@$Tmp_prefix.opts $output +RTS @HsC_rts_flags";
2019 $to_do = "$HsC @HsP_flags ,$hscpp_hsc $dump @HsC_flags $CoreLint $StgLint $Verbose $output +RTS @HsC_rts_flags";
2021 &run_something($to_do, 'Haskell compiler');
2023 # finish business w/ nofibbish time/bytes-alloc stats
2024 &process_ghc_timings() if $CollectGhcTimings;
2028 Use \tr{@Import_dir} and \tr{@SysImport_dir} to make a tmp file
2029 of (module-name, pathname) pairs, one per line, separated by a space.
2032 $HiIncludeString = (); # dir1:dir2:dir3, to pass to GHC
2036 # collect in %HiMap; write later; also used elsewhere in driver
2038 local($mod, $path, $d, $e);
2040 # reset the global variables:
2042 $HiIncludeString = (); # dir1:dir2:dir3, to pass to GHC
2044 foreach $d ( @Import_dir ) {
2045 if ($HiIncludeString) {
2046 $HiIncludeString = "$HiIncludeString:${d}%.${HiSuffix}";
2048 $HiIncludeString = "$d%.${HiSuffix}";
2053 foreach $d ( @SysImport_dir ) {
2054 if ($HiIncludeString) {
2055 $HiIncludeString = "$HiIncludeString:${d}%.${HiSuffix_prelude}";
2057 $HiIncludeString = "${d}%.${HiSuffix_prelude}";
2066 %************************************************************************
2068 \section[Driver-misc-utils]{Miscellaneous utilities}
2070 %************************************************************************
2072 %************************************************************************
2074 \subsection[Driver-odir-ify]{@odir_ify@: Mangle filename if \tr{-odir} set}
2076 %************************************************************************
2080 local($ofile,$def_suffix) = @_;
2082 return(($Osuffix eq '') ? "$ofile.$def_suffix" : "$ofile.$Osuffix" );
2086 local($orig_file, $def_suffix) = @_;
2087 if ($Specific_output_dir eq '') { # do nothing
2088 &osuf_ify($orig_file, $def_suffix);
2090 local ($orig_file_only);
2091 ($orig_file_only = $orig_file) =~ s|.*/||;
2092 &osuf_ify("$Specific_output_dir/$orig_file_only",$def_suffix);
2099 local($is_hc_file, $hsc_out, $cc_as_o) = @_;
2101 local($includes) = '-I' . join(' -I', @Include_dir);
2104 local($c_flags) = "@CcBoth_flags";
2105 local($ddebug_flag) = ( $DEBUGging ) ? '-DDEBUG' : '';
2107 $c_flags .= " -mno-cygwin" if ( $TargetPlatform =~ /-mingw32$/ );
2109 # "input" files to use that are not in some weird directory;
2110 # to help C compilers grok .hc files [ToDo: de-hackify]
2111 local($cc_help) = "ghc$$.c";
2112 local($cc_help_s) = "ghc$$.s";
2115 $s_output = (($is_hc_file && $DoAsmMangling) || $TargetPlatform =~ /^(powerpc|rs6000|hppa)/) ? $cc_as_o : $cc_as;
2116 $c_flags .= " @CcRegd_flags";
2117 $c_flags .= ($is_hc_file) ? " @CcRegd_flags_hc" : " @CcRegd_flags_c";
2119 # C compiler won't like the .hc extension. So we create
2120 # a tmp .c file which #include's the needful.
2121 open(TMP, "> $cc_help") || &tidy_up_and_die(1,"$Pgm: failed to open `$cc_help' (to write)\n");
2122 if ( $is_hc_file ) {
2126 # user may have asked for #includes to be injected...
2127 print TMP @CcInjects if $#CcInjects >= 0;
2129 # Straight .c files may want to know that they're being used
2130 # with a particular version of GHC, so we define __GLASGOW_HASKELL__ for their benefit.
2131 print TMP "#define __GLASGOW_HASKELL__ ${ProjectVersionInt}\n";
2133 # heave in the consistency info
2134 print TMP "static char ghc_cc_ID[] = \"\@(#)cc $ifile\t$Cc_major_version.$Cc_minor_version,$Cc_consist_options\";\n";
2136 print TMP "#include \"$hsc_out\"\n";
2137 close(TMP) || &tidy_up_and_die(1,"Failed writing to $cc_help\n");
2139 # Don't redirect stderr into intermediate file if slamming output onto stdout (e.g., with -E)
2140 local($fuse_stderr) = "2>&1" if ! $Only_preprocess_hc;
2141 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 )";
2143 if ( $Only_preprocess_hc ) { # HACK ALERT!
2144 $to_do =~ s/ -S\b//g;
2146 push(@Files_to_tidy, $cc_help, $cc_help_s, $s_output );
2147 $PostprocessCcOutput = 1 if ! $Only_preprocess_hc; # hack, dear hack...
2148 &run_something($to_do, 'C compiler');
2149 $PostprocessCcOutput = 0;
2150 if ( $Only_preprocess_hc ) {
2151 system("$Cat $Tmp_prefix.ccout");
2153 unlink($cc_help, $cc_help_s);
2159 local($is_hc_file, $cc_as_o, $cc_as, $ifile_root) = @_;
2161 print STDERR `cat $cc_as_o` if $Dump_raw_asm; # to stderr, before mangling
2163 if ($is_hc_file && $DoAsmMangling) {
2164 # dynamically load assembler-fiddling code, which we are about to use:
2165 require('ghc-asm.prl')
2166 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm.prl!\n");
2167 # post-process the assembler [.hc files only]
2168 &mangle_asm($cc_as_o, $cc_as);
2170 } elsif ($TargetPlatform =~ /^hppa/) {
2171 # minor mangling of non-threaded files for hp-pa only
2172 require('ghc-asm.prl')
2173 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-hppa.prl!\n");
2174 &mini_mangle_asm_hppa($cc_as_o, $cc_as);
2176 } elsif ($TargetPlatform =~ /^powerpc|^rs6000/) {
2177 # minor mangling of non-threaded files for powerpcs and rs6000s
2178 require('ghc-asm.prl')
2179 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-powerpc.prl!\n");
2180 &mini_mangle_asm_powerpc($cc_as_o, $cc_as);
2183 # save a copy of the .s file, even if we are carrying on...
2184 #if ($do_as && $Keep_s_file_too) {
2185 # &saveIntermediate($ifile_root , "s" , $cc_as);
2192 local($as_out, $ifile_root) = @_;
2194 local($asmblr) = ( $As ) ? $As : $CcRegd;
2196 # need to add the -I flags in case the file is going through cpp (.S files)
2197 local($includes) = '-I' . join(' -I', @Include_dir);
2199 if ( ! $SplitObjFiles ) {
2200 local($to_do) = "$asmblr -o $as_out -c @As_flags $includes $cc_as";
2201 push(@Files_to_tidy, $as_out );
2202 &run_something($to_do, 'Unix assembler');
2204 } else { # more complicated split-ification...
2206 # must assemble files $Tmp_prefix__[1 .. $NoOfSplitFiles].s
2208 # If -odir is used, great, just pin it in front of the
2209 # generated split file names. If it hasn't been set, we
2210 # snatch it from the ifile_root.
2214 if ( $Specific_output_dir eq '' ) {
2215 $Specific_output_dir = ${ifile_root};
2218 for ($f = 1; $f <= $NoOfSplitFiles; $f++ ) {
2219 local($split_out) = &odir_ify("${ifile_root}__${f}",'o');
2220 local($to_do) = "$asmblr -o $split_out -c @As_flags ${Tmp_prefix}__${f}.s";
2221 push(@Files_to_tidy, $split_out );
2223 &run_something($to_do, 'Unix assembler');
2229 %************************************************************************
2231 \subsection[Driver-run-something]{@run_something@: Run a phase}
2233 %************************************************************************
2237 local($str_to_do, $tidy_name) = @_;
2239 print STDERR "\n$tidy_name:\n\t" if $Verbose;
2240 print STDERR "$str_to_do\n" if $Verbose;
2242 if ($Using_dump_file) {
2243 open(DUMP, ">> $Specific_dump_file")
2244 || &tidy_up_and_die(1,"$Pgm: failed to open `$Specific_dump_file'\n");
2245 print DUMP "\nCompilation Dump for: $str_to_do\n\n";
2247 || &tidy_up_and_die(1,"$Pgm: failed closing `$Specific_dump_file'\n");
2250 local($return_val) = 0;
2252 if ( length($str_to_do) > 4000) {
2253 # 4000 - on the random side, just like the *real* ARG_MAX
2256 # With some shells, command lines of this length may
2257 # very well cause trouble. To safeguard against this, we squirrel the
2258 # command into a file and exec that.
2259 local ($sh) = $ENV{'REAL_SHELL'};
2260 print STDERR "Backup plan A: saving cmd line in ${Tmp_prefix}.sh and executing that with $sh\n" if $Verbose;
2261 open (TEMP, "> ${Tmp_prefix}.sh") ||
2262 &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.sh'\n");
2263 print TEMP "$Time $str_to_do\n";
2265 &tidy_up_and_die(1,"$Pgm: failed closing `$Tmp_prefix.sh'\n");
2266 system("$sh $Tmp_prefix.sh");
2269 unlink "${Tmp_prefix}.sh";
2271 system("$Time $str_to_do");
2275 if ( $PostprocessCcOutput ) { # hack, continued
2276 open(CCOUT, "< $Tmp_prefix.ccout")
2277 || &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.ccout'\n");
2279 next if /call-clobbered/;
2280 next if /control reaches end/;
2281 next if /from .*Stg\.h:/;
2282 next if /from ghc\d+.c:\d+:/;
2283 next if /: At top level:$/;
2284 next if /: In function \`.*\':$/;
2285 next if /\`ghc_cc_ID\' defined but not used/;
2288 close(CCOUT) || &tidy_up_and_die(1,"$Pgm: failed closing `$Tmp_prefix.ccout'\n");
2291 if ($return_val != 0) {
2292 if ($Using_dump_file) {
2293 print STDERR "Compilation Errors dumped in $Specific_dump_file\n";
2295 &tidy_up_and_die($return_val, '');
2297 $Using_dump_file = 0;
2301 %************************************************************************
2303 \subsection[Driver-ghc-timing]{Emit nofibbish GHC timings}
2305 %************************************************************************
2307 NB: nearly the same as in @runstdtest@ script.
2310 sub process_ghc_timings {
2311 local($StatsFile) = "$Tmp_prefix.stat";
2312 local($SysSpecificTiming) = 'ghc';
2314 open(STATS, $StatsFile) || die "Failed when opening $StatsFile\n";
2315 local($max_live) = 0;
2316 local($tot_live) = 0; # for calculating residency stuff
2317 local($tot_samples) = 0;
2320 if (! /Gen:\s+0/ && ! /Minor/ && /^\s*\d+\s+\d+\s+(\d+)\s+\d+\.\d+/ ) {
2321 $max_live = $1 if $max_live < $1;
2325 $BytesAlloc = $1 if /^\s*([0-9,]+) bytes allocated in the heap/;
2327 if ( /^\s*([0-9,]+) bytes maximum residency .* (\d+) sample/ ) {
2328 $MaxResidency = $1; $ResidencySamples = $2;
2331 $GCs = $1 if /^\s*([0-9,]+) (collections? in generation 0|garbage collections? performed)/;
2333 if ( /^\s+([0-9]+)\s+Mb total memory/ ) {
2337 # The presence of -? in the following pattern is only there to
2338 # accommodate 0.29 && <= 2.05 RTS'
2339 if ( /^\s*INIT\s+time\s*(\d+\.\d\d)s\s*\(\s*-?(\d+\.\d\d)s elapsed\)/ ) {
2340 $InitTime = $1; $InitElapsed = $2;
2341 } elsif ( /^\s*MUT\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2342 $MutTime = $1; $MutElapsed = $2;
2343 } elsif ( /^\s*GC\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2344 $GcTime = $1; $GcElapsed = $2;
2347 close(STATS) || die "Failed when closing $StatsFile\n";
2348 if ( $tot_samples > 0 ) {
2349 $ResidencySamples = $tot_samples;
2350 $MaxResidency = $max_live;
2351 $AvgResidency = int ($tot_live / $tot_samples) ;
2354 # warn about what we didn't find
2355 print STDERR "Warning: BytesAlloc not found in stats file\n" unless defined($BytesAlloc);
2356 print STDERR "Warning: GCs not found in stats file\n" unless defined($GCs);
2357 print STDERR "Warning: InitTime not found in stats file\n" unless defined($InitTime);
2358 print STDERR "Warning: InitElapsed not found in stats file\n" unless defined($InitElapsed);
2359 print STDERR "Warning: MutTime not found in stats file\n" unless defined($MutTime);
2360 print STDERR "Warning: MutElapsed not found in stats file\n" unless defined($MutElapsed);
2361 print STDERR "Warning: GcTime inot found in stats file\n" unless defined($GcTime);
2362 print STDERR "Warning: GcElapsed not found in stats file\n" unless defined($GcElapsed);
2364 # things we didn't necessarily expect to find
2365 $MaxResidency = 0 unless defined($MaxResidency);
2366 $AvgResidency = 0 unless defined($AvgResidency);
2367 $ResidencySamples = 0 unless defined($ResidencySamples);
2370 $BytesAlloc =~ s/,//g;
2371 $MaxResidency =~ s/,//g;
2373 $InitTime =~ s/,//g;
2374 $InitElapsed =~ s/,//g;
2376 $MutElapsed =~ s/,//g;
2378 $GcElapsed =~ s/,//g;
2380 # print out what we found
2381 print STDERR "<<$SysSpecificTiming: ",
2382 "$BytesAlloc bytes, $GCs GCs, $AvgResidency/$MaxResidency avg/max bytes residency ($ResidencySamples samples), ${TotMem}M in use, $InitTime INIT ($InitElapsed elapsed), $MutTime MUT ($MutElapsed elapsed), $GcTime GC ($GcElapsed elapsed)",
2383 " :$SysSpecificTiming>>\n";
2390 %************************************************************************
2392 \subsection[Driver-dying]{@tidy_up@ and @tidy_up_and_die@: Dying gracefully}
2394 %************************************************************************
2398 local($to_do) = "\n$Rm $Tmp_prefix*";
2399 if ( $Tmp_prefix !~ /^\s*$/ ) {
2400 print STDERR "$to_do\n" if $Verbose;
2405 sub tidy_up_and_die {
2406 local($return_val, $msg) = @_;
2408 # delete any files to tidy
2409 print STDERR "deleting... @Files_to_tidy\n" if $Verbose && $#Files_to_tidy >= 0;
2410 unlink @Files_to_tidy if $#Files_to_tidy >= 0;
2414 exit (($return_val == 0) ? 0 : 1);
2418 %************************************************************************
2420 \subsection[Driver-arg-with-arg]{@grab_arg_arg@: Do an argument with an argument}
2422 %************************************************************************
2424 Some command-line arguments take an argument, e.g.,
2425 \tr{-Rmax-heapsize} expects a number to follow. This can either be
2426 given a part of the same argument (\tr{-Rmax-heapsize8M}) or as the
2427 next argument (\tr{-Rmax-heapsize 8M}). We allow both cases.
2429 Note: no error-checking; \tr{-Rmax-heapsize -Rgc-stats} will silently
2430 gobble the second argument (and probably set the heapsize to something
2434 local(*Args, $option, $rest_of_arg) = @_;
2436 if ($rest_of_arg ne '') {
2437 return($rest_of_arg);
2438 } elsif ($#Args >= 0) {
2439 local($temp) = $Args[0]; shift(@Args);
2442 print STDERR "$Pgm: no argument following $option option\n";
2453 #Not in HsC_antiflag ## NO!: and not already in HsC_flags
2455 foreach $f ( @HsC_antiflags ) {
2456 return(0) if $flag eq $f;
2458 # foreach $f ( @HsC_flags ) {
2459 # return(0) if $flag eq $f;
2464 sub squashHscFlag { # pretty terrible
2468 foreach $f ( @HsC_flags ) {
2469 if ($flag eq $f) { $f = ''; }
2477 foreach $f ( @flags ) {
2478 push( @HsC_flags, $f ) if &isntAntiFlag($f);
2483 To add another system library, you'll need to augment the
2484 Supported_syslibs variable with name and info on your addition
2485 to the syslib family. The info bit consist of the following:
2487 - interface file directory
2488 see the misc or posix entry for how to distinguish
2489 between using installed and build tree directories.
2491 - directory location of archives
2493 - location of (way-independent) C support libs.
2494 not all libraries need this - if you don't, just
2495 give the empty string.
2496 - list of syslibs you depend on.
2498 - additional ghc command line flags that should be used.
2499 - additional C compiler command line flags that should be used.
2505 # Hash to keep track of
2506 %Syslibs_added = ();
2509 local($syslib) = @_;
2511 # Lifting this out of this sub brings it out of scope - why??
2512 %Supported_syslibs =
2514 [ # where to slurp interface files from
2516 ? "$InstLibDirGhc/imports/exts"
2517 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/exts"
2519 , # where to find the archive to use when linking
2522 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/exts"
2525 , '' # Syslib dependencies
2526 , '' # extra ghc opts
2527 , '' # extra cc opts
2528 , '' # extra ld opts
2532 [ # where to slurp interface files from
2534 ? "$InstLibDirGhc/imports/misc"
2535 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/misc"
2537 , # where to find the archive to use when linking
2540 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/misc"
2542 , # where to find the cbits archive to use when linking
2545 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/misc/cbits"
2547 , 'exts' # Syslib dependencies
2548 , '' # extra ghc opts
2549 , '' # extra cc opts
2550 , ( $TargetPlatform =~ /-solaris2$/ ? '-lnsl -lsocket' : '')
2553 [ # where to slurp interface files from
2555 ? "$InstLibDirGhc/imports/hbc"
2556 : "$TopPwd/CONTRIB/libraries/hbc/src"
2558 , # where to find the archive to use when linking
2561 : "$TopPwd/CONTRIB/libraries/src/hbc"
2563 , # where to find the cbits archive to use when linking
2566 : "$TopPwd/CONTRIB/libraries/hbc/cbits"
2568 , 'exts' # Syslib dependencies
2569 , '' # extra ghc opts
2570 , '' # extra cc opts
2574 [ # where to slurp interface files from
2576 ? "$InstLibDirGhc/imports/posix"
2577 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/posix"
2579 , # where to find the archive to use when linking
2582 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/posix"
2584 , # where to find the cbits archive to use when linking
2587 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/posix/cbits"
2589 , 'misc' # Syslib dependencies
2590 , '' # extra ghc opts
2591 , '' # extra cc opts
2592 , '' # extra ld opts
2595 [ # where to slurp interface files from
2597 ? "$InstLibDirGhc/imports/concurrent"
2598 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/concurrent"
2600 , # where to find the archive to use when linking
2603 : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/concurrent"
2605 , '' # where to find the cbits archive to use when linking
2606 , '' # Syslib dependencies
2607 , '' # extra ghc opts
2608 , '' # extra cc opts
2609 , '' # extra ld opts
2612 [ # where to slurp interface files from
2614 ? "$InstLibDirGhc/imports/win32"
2615 : "$TopPwd/hslibs/win32/src"
2617 , # where to find the archive to use when linking
2620 : "$TopPwd/hslibs/win32/src"
2623 , 'exts' # Syslib dependencies
2624 , '' # extra ghc opts
2625 , '' # extra cc opts
2626 , '-luser32 -lgdi32' # extra ld opts
2630 # check if it's supported..
2632 if ( !exists $Supported_syslibs{$syslib} ) {
2633 print STDERR "$Pgm: no such system library (-syslib): $syslib\n";
2638 # This check is here to avoid syslib loops from
2639 # spoiling the party. A side-effect of it is that
2640 # it disallows multiple mentions of a syslib on a command-line,
2641 # explicit *and* implicit ones (i.e., "-syslib exts -syslib misc"
2642 # is not equal to "-syslib exts -syslib misc -syslib exts",
2643 # which it needs to be)
2645 # Since our current collection of syslibs don't have any
2646 # loops, this test is disabled.
2648 # ToDo: loop avoidance scheme when the need arises
2650 #return if ( exists $Syslibs_added{$syslib} );
2652 $Syslibs_added{$syslib} = 1;
2654 local ($hi_dir, $lib_dir, $lib_cbits_dir,
2655 $syslib_deps, $syslib_ghc_opts,
2656 $syslib_cc_opts, $syslib_ld_opts) = @{ $Supported_syslibs{$syslib} };
2659 unshift(@SysImport_dir, $hi_dir);
2660 push(@SysLibrary_dir, $lib_dir);
2661 push(@SysLibrary_dir, $lib_cbits_dir) if ( $lib_cbits_dir ne '');
2663 push(@SysLibrary, "-lHS$syslib");
2664 push(@SysLibrary, "-lHS${syslib}_cbits") if ( $lib_cbits_dir ne '');
2665 push(@SysLibrary, $syslib_ld_opts) if ($syslib_ld_opts ne '');
2667 # Add on any extra dependencies.
2668 foreach $lib (split(' ',$syslib_deps)) {
2674 Source files may have {-# OPTIONS ... #-} pragmas at the top, containing
2675 command line options we want to append to collection of commands specified
2676 directly. @check_for_source_options@ looks at the top of a de-lit'ified Haskell
2677 file for any such pragmas:
2680 sub check_for_source_options {
2681 local($file,$ifile) = @_;
2682 local($comment_start,$comment_end);
2684 if ($ifile =~ /\.hc$/ ||
2687 $ifile =~ /_s$/ ) { # `Real' C intermediate
2688 $comment_start = "/\\*";
2689 $comment_end = "\\*/";
2690 } else { # Assume it is a file containing Haskell source
2691 $comment_start = "{-#";
2692 $comment_end = "#-}";
2695 open(FILE,$file) || return(1); # No big loss
2698 if ( /^${comment_start} OPTIONS (.*)${comment_end}$/ ) {
2699 # add the options found at the back of the command line.
2700 local(@entries) = split(/\s+/,$1);
2701 print STDERR "Found OPTIONS " . join(' ',@entries) . " in $file\n" if $Verbose;
2702 push(@File_options, @entries);
2704 elsif ( /^$/ ) { # ignore empty lines
2707 elsif ( /^#line.+$/ ) { # ignore comment lines (unused..ToDo: rm )
2710 elsif ( /^{-# LINE.+$/ ) { # ignore line pragmas
2713 else { # stop looking, something non-empty / not
2714 # ${comment_start} OPTIONS .. ${comment_end} encountered.
2715 close(FILE);return(0);
2724 We split the initial argv up into three arrays:
2730 the reason for doing so is to be able to deal
2731 with {-# OPTIONS #-} pragma in source files properly.
2737 arg: while($_ = $args[0]) {
2739 # sigh, we have to deal with these -option arg specially here.
2740 /^-(tmpdir|odir|ohi|o|isuf|osuf|hisuf|odump|syslib)$/ &&
2741 do { push(@Cmd_opts, $_); push(@Cmd_opts,$args[0]); shift(@args); next arg; };
2742 /^--?./ && do { push(@Cmd_opts, $_); next arg; };
2744 if (/\.([^_]+_)?[oa]$/) {
2745 push(@Link_file, $_);
2747 push(@Input_file, $_);
2750 # input files must exist:
2752 print STDERR "$Pgm: input file doesn't exist: $_\n";
2760 When saving an intermediate file (.hc or .s) away, we
2761 have to prefix any OPTIONS found in the original source file.
2764 sub saveIntermediate {
2765 local ($final,$suffix,$tmp)= @_ ;
2768 # $final -- root of where to park ${final}.${suffix}
2769 # $tmp -- temporary file where hsc put the intermediate file.
2771 # Delete the old file
2772 $to_do = "$Rm ${final}.${suffix}"; &run_something($to_do, "Removing old .${suffix} file");
2774 if ( $#File_options >= 0 ) { # OPTIONS found in Haskell source unit
2775 # Add OPTION comment to the top of the generated .${suffix} file
2776 open(TEMP, "> ${final}.${suffix}") || &tidy_up_and_die(1,"Can't open ${final}.${suffix}\n");
2777 print TEMP "/* OPTIONS " . join(' ',@File_options) . " */\n";
2779 print STDERR "Prepending OPTIONS: " . join(' ',@File_options) . " to ${final}.${suffix}\n" if $Verbose;
2781 $to_do = "$Cat $tmp >> ${final}.${suffix}";
2782 &run_something($to_do, "Saving copy of .${suffix} file");
2789 Command-line processor
2795 # can't use getopt(s); what we want is too complicated
2797 arg: while($_ = $Args[0]) {
2800 #---------- help -------------------------------------------------------
2801 if (/^-\?$/ || /^--?help$/) { print $LongUsage; exit $Status; }
2803 #-----------version ----------------------------------------------------
2804 /^--version$/ && do { print STDERR "${ProjectName}, version ${ProjectVersion}, patchlevel ${ProjectPatchLevel}\n"; exit $Status; };
2806 #---------- verbosity and such -----------------------------------------
2807 /^-v$/ && do { $Verbose = '-v'; $Time = 'time'; next arg; };
2809 #---------- what phases are to be run ----------------------------------
2810 /^-(no-)?recomp/ && do { $Do_recomp_chkr = ($1 eq '') ? 1 : 0; next arg; };
2812 /^-cpp$/ && do { $Cpp_flag_set = 1; next arg; };
2813 # change the global default:
2814 # we won't run cat; we'll run the real thing
2816 /^-C$/ && do { $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0; $HscOut = '-C=';
2818 # stop after generating C
2820 /^-noC$/ && do { $HscOut = '-N='; $ProduceHi = '-nohifile=';
2821 $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0;
2823 # leave out actual C generation (debugging) [also turns off interface gen]
2826 /^-hi$/ && do { $HiOnStdout = 1; $ProduceHi = '-hifile='; next arg; };
2827 # _do_ generate an interface; usually used as: -noC -hi
2828 /^-hi-with-(.*)$/ && do { $HiOnStdout = 1; $HiWith .= " $1" ; $ProduceHi = '-hifile='; next arg; };
2829 # limit ourselves to outputting a particular section.
2831 /^-nohi$/ && do { $ProduceHi = '-nohifile='; next arg; };
2832 # don't generate an interface (even if generating C)
2834 /^-hi-diffs$/ && do { $HiDiff_flag = 'normal'; next arg; };
2835 /^-hi-diffs-with-usages$/ && do { $HiDiff_flag = 'usages'; next arg; };
2836 /^-no-hi-diffs$/ && do { $HiDiff_flag = ''; next arg; };
2837 /^-keep-hi-diffs$/ && do { $Keep_HiDiffs = 1; next arg; };
2839 # show/disable diffs if the interface file changes
2841 /^-E$/ && do { push(@CcBoth_flags, '-E');
2842 $Only_preprocess_C = 1;
2843 $Do_as = 0; $Do_lnkr = 0; next arg; };
2844 # stop after preprocessing C
2845 /^-M$/ && do { $Only_generate_deps = 1; $Do_as = 0; $Do_lnkr = 0; next arg; };
2846 # only generate dependency information.
2847 /^-S$/ && do { $Do_as = 0; $Do_lnkr = 0; next arg; };
2848 # stop after generating assembler
2850 /^-c$/ && do { $Do_lnkr = 0; next arg; };
2851 # stop after generating .o files
2853 /^-link-chk$/ && do { $LinkChk = 1; next arg; };
2854 # don't do consistency-checking after a link
2855 /^-no-link-chk$/ && do { $LinkChk = 0; next arg; };
2857 /^-tmpdir$/ && do { $Tmp_prefix = &grab_arg_arg(*Args,'-tmpdir', '');
2858 $Tmp_prefix = "$Tmp_prefix/ghc$$";
2859 $ENV{'TMPDIR'} = $Tmp_prefix; # for those who use it...
2861 # use an alternate directory for temp files
2863 #---------- redirect output --------------------------------------------
2865 # -o <file>; applies to the last phase, whatever it is
2866 # "-o -" sends it to stdout
2867 # if <file> has a directory component, that dir must already exist
2869 /^-odir$/ && do { $Specific_output_dir = &grab_arg_arg(*Args,'-odir', '');
2871 # Hack, of the worst sort: don't do validation of
2872 # odir argument if you're using -M (dependency generation).
2874 if ( ! $Only_generate_deps && ! -d $Specific_output_dir) {
2875 print STDERR "$Pgm: -odir: no such directory: $Specific_output_dir\n";
2880 /^-o$/ && do { $Specific_output_file = &grab_arg_arg(*Args,'-o', '');
2881 if ($Specific_output_file ne '-'
2882 && $Specific_output_file =~ /(.*)\/[^\/]*$/) {
2883 local($dir_part) = $1;
2884 if (! -d $dir_part) {
2885 print STDERR "$Pgm: no such directory: $dir_part\n";
2891 # NB: -isuf not documented yet (because it doesn't work yet)
2892 /^-isuf$/ && do { $Isuffix = &grab_arg_arg(*Args,'-isuf', '');
2893 if ($Isuffix =~ /\./ ) {
2894 print STDERR "$Pgm: -isuf suffix shouldn't contain a .\n";
2899 /^-osuf$/ && do { $Osuffix = &grab_arg_arg(*Args,'-osuf', '');
2900 if ($Osuffix =~ /\./ ) {
2901 print STDERR "$Pgm: -osuf suffix shouldn't contain a .\n";
2906 # -ohi <file>; send the interface to <file>; "-ohi -" to send to stdout
2907 /^-ohi$/ && do { $Specific_hi_file = &grab_arg_arg(*Args,'-ohi', '');
2908 if ($Specific_hi_file ne '-'
2909 && $Specific_hi_file =~ /(.*)\/[^\/]*$/) {
2910 local($dir_part) = $1;
2911 if (! -d $dir_part) {
2912 print STDERR "$Pgm: no such directory: $dir_part\n";
2916 $ProduceHi='-hifile=';
2919 # The suffix to use when looking for interface files
2920 /^-hisuf$/ && do { $HiSuffix = &grab_arg_arg(*Args,'-hisuf', '');
2921 if ($HiSuffix =~ /\./ ) {
2922 print STDERR "$Pgm: -hisuf suffix shouldn't contain a .\n";
2926 /^-odump$/ && do { $Specific_dump_file = &grab_arg_arg(*Args,'-odump', '');
2927 if ($Specific_dump_file =~ /(.*)\/[^\/]*$/) {
2928 local($dir_part) = $1;
2929 if (! -d $dir_part) {
2930 print STDERR "$Pgm: no such directory: $dir_part\n";
2936 #-------------- scc & Profiling Stuff ----------------------------------
2938 /^-prof$/ && do { $PROFing = 'p'; next arg; }; # profiling -- details later!
2941 # generate auto SCCs on top level bindings
2942 # -auto-all = all top level bindings
2943 # -auto = only top level exported bindings
2944 $PROFauto = ( /-all/ )
2945 ? '-fauto-sccs-on-all-toplevs'
2946 : '-fauto-sccs-on-exported-toplevs';
2949 /^-caf-all/ && do { # generate individual CAF SCC annotations
2950 $PROFcaf = '-fauto-sccs-on-individual-cafs';
2953 /^-ignore-scc$/ && do {
2954 # forces ignore of scc annotations even if profiling
2955 $PROFignore_scc = '-W';
2958 /^-G(.*)$/ && do { push(@HsC_flags, "-G=$1"); # set group for cost centres
2961 /^-unprof-scc-auto/ && do {
2962 # generate auto SCCs on top level bindings when not profiling.
2963 # Used to measure optimisation effects of presence of sccs.
2964 $UNPROFscc_auto = ( /-all/ )
2965 ? '-fauto-sccs-on-all-toplevs'
2966 : '-fauto-sccs-on-exported-toplevs';
2969 #--------- ticky/parallel ----------------------------------------------
2970 # we sort out the details a bit later on
2972 /^-gransim$/ && do { $GRANing = 'g'; &add_syslib('concurrent'); next arg; }; # GranSim
2973 /^-ticky$/ && do { $TICKYing = 't'; next arg; }; # ticky-ticky
2974 /^-parallel$/ && do { $PARing = 'p'; &add_syslib('concurrent'); next arg; }; # parallel Haskell
2976 #-------------- "user ways" --------------------------------------------
2978 (/^-user-setup-([a-oA-Z])$/ ) &&
2980 /^-user-setup-([a-oA-Z])$/ && do { $BuildTag = "_$1"; };
2982 local($stuff) = $UserSetupOpts{$BuildTag};
2983 local(@opts) = split(/\s+/, $stuff);
2985 # feed relevant ops into the arg-processing loop (if any)
2986 unshift(@Args, @opts) if $#opts >= 0;
2990 #---------- set search paths for libraries and things ------------------
2992 # we do -i just like HBC (-i clears the list; -i<colon-separated-items>
2993 # prepends the items to the list); -I is for including C .h files.
2995 /^-i$/ && do { @Import_dir = (); # import path cleared!
2996 @SysImport_dir = ();
2997 print STDERR "WARNING: import paths cleared by `-i'\n";
3000 /^-i(.*)/ && do { local(@new_items)
3001 = split( /:/, &grab_arg_arg(*Args,'-i', $1));
3002 unshift(@Import_dir, @new_items);
3005 /^-I(.*)/ && do { push(@Include_dir, &grab_arg_arg(*Args,'-I', $1)); next arg; };
3006 /^-L(.*)/ && do { push(@UserLibrary_dir, &grab_arg_arg(*Args,'-L', $1)); next arg; };
3007 /^-l(.*)/ && do { push(@UserLibrary,'-l'.&grab_arg_arg(*Args,'-l', $1)); next arg; };
3009 /^-syslib(.*)/ && do { local($syslib) = &grab_arg_arg(*Args,'-syslib',$1);
3010 &add_syslib($syslib);
3013 #=======================================================================
3014 # various flags that we can harmlessly send to one program or another
3015 # (we will later "reclaim" some of the compiler ones now sent to gcc)
3016 #=======================================================================
3018 #---------- this driver itself (ghc) -----------------------------------
3019 # these change what executable is run for each phase:
3020 /^-pgmL(.*)$/ && do { $Unlit = $1; next arg; };
3021 /^-pgmP(.*)$/ && do { $HsCpp = $1; next arg; };
3022 /^-pgmC(.*)$/ && do { $HsC = $1; next arg; };
3023 /^-pgmcO?(.*)$/ && do { $CcRegd = $1; next arg; }; # the O? for back compat
3024 /^-pgma(.*)$/ && do { $As = $1; next arg; };
3025 /^-pgml(.*)$/ && do { $Lnkr = $1; next arg; };
3026 /^-pgmdep(.*)$/ && do { $MkDependHS = $1; next arg; };
3028 #---------- the get-anything-through opts (all pgms) -------------------
3029 # these allow arbitrary option-strings to go to any phase:
3030 /^-optL(.*)$/ && do { push(@Unlit_flags, $1); next arg; };
3031 /^-optP(.*)$/ && do { push(@HsCpp_flags, $1); next arg; };
3032 /^-optCrts(.*)$/&& do { push(@HsC_rts_flags, $1); next arg; };
3033 /^-optC(.*)$/ && do { push(@HsC_flags, $1); next arg; };
3034 /^-optp(.*)$/ && do { push(@HsP_flags, $1); next arg; };
3035 /^-optcpp(.*)$/ && do { push(@Cpp_define, $1); $Only_preprocess_hc = ($1 eq "-E"); next arg; };
3036 /^-optc(.*)$/ && do { push(@CcBoth_flags, $1); next arg; };
3037 /^-opta(.*)$/ && do { push(@As_flags, $1); next arg; };
3038 /^-optl(.*)$/ && do { push(@Ld_flags, $1); next arg; };
3039 /^-optdep(.*)$/ && do { push(@MkDependHS_flags, $1); next arg; };
3041 #---------- Haskell C pre-processor (hscpp) ----------------------------
3042 /^-D(.*)/ && do { push(@HsCpp_flags, "'-D".&grab_arg_arg(*Args,'-D',$1)."'"); next arg; };
3043 /^-U(.*)/ && do { push(@HsCpp_flags, "'-U".&grab_arg_arg(*Args,'-U',$1)."'"); next arg; };
3045 #---------- post-Haskell "assembler"------------------------------------
3046 /^-ddump-raw-asm$/ && do { $Dump_raw_asm = 1; next arg; };
3047 /^-ddump-asm-splitting-info$/ && do { $Dump_asm_splitting_info = 1; next arg; };
3049 #---------- Haskell compiler (hsc) -------------------------------------
3051 /^-keep-hc-files?-too$/ && do { $Keep_hc_file_too = 1; next arg; };
3052 /^-keep-s-files?-too$/ && do { $Keep_s_file_too = 1; next arg; };
3054 /^-fignore-interface-pragmas$/ && do { push(@HsC_flags, $_); next arg; };
3056 /^-fno-implicit-prelude$/ && do { $NoImplicitPrelude= 1; push(@HsC_flags, $_); next arg; };
3059 # have the compiler proper generate concurrent code,
3060 # really only used when you want to configure your own
3061 # special user compilation way.
3063 # (ditto for -fgransim, fscc-profiling, -fparallel and -fticky-ticky)
3065 /^-fscc-profiling$/ && do { push(@HsC_flags,$_); next arg; };
3066 /^-fticky-ticky$/ && do { push(@HsC_flags,$_); next arg; };
3067 /^-fgransim$/ && do { push(@HsC_flags,$_); next arg; };
3068 /^-fparallel$/ && do { push(@HsC_flags,$_); next arg; };
3070 /^-split-objs$/ && do {
3071 if ( $TargetPlatform !~ /^(alpha|hppa1\.1|i386|m68k|mips|powerpc|rs6000|sparc)-/ ) {
3073 print STDERR "WARNING: don't know how to split objects on this platform: $TargetPlatform\n`-split-objs' option ignored\n";
3078 push(@HsC_flags, "-fglobalise-toplev-names");
3079 push(@CcBoth_flags, '-DUSE_SPLIT_MARKERS');
3081 require('ghc-split.prl')
3082 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-split.prl!\n");
3086 /^-fno-asm-mangling$/ && do { $DoAsmMangling = 0; next arg; };
3088 /^-fallow-overlapping-instances$/ && do { push(@HsC_flags, $_); next arg; };
3089 /^-fallow-undecidable-instances$/ && do { push(@HsC_flags, $_); next arg; };
3091 && do { push(@HsC_flags, $_);
3092 push(@HsP_flags, '-N');
3094 # -fglasgow-exts implies -syslib exts
3095 &add_syslib('exts');
3100 && do { $Oopt_DoSpecialise = '-fspecialise'; next arg; };
3101 /^-fno-speciali[sz]e$/
3102 && do { $Oopt_DoSpecialise = ''; next arg; };
3105 # Now the foldr/build options, which are *on* by default (for -O).
3108 && do { $Oopt_FoldrBuild = 1;
3109 $Oopt_FB_Support = '-fdo-arity-expand';
3113 /^-fno-foldr-build$/
3114 && do { $Oopt_FoldrBuild = 0;
3115 $Oopt_FB_Support = '';
3118 /^-fno-foldr-build-rule$/
3119 && do { $Oopt_FoldrBuild = 0;
3122 /^-fno-enable-tech$/
3123 && do { $Oopt_FB_Support = '';
3126 /^-fno-snapback-to-append$/
3127 && do { $Oopt_FoldrBuildInline .= ' -fdo-not-fold-back-append ';
3130 # --------------- Renamer -------------
3133 /^-fno-prune-tydecls$/ && do { push(@HsC_flags, $_); next arg; };
3134 /^-fno-prune-instdecls$/ && do { push(@HsC_flags, $_); next arg; };
3138 /^-fasm-(.*)$/ && do { $HscOut = '-S='; next arg; }; # force using nativeGen
3139 /^-fvia-[cC]$/ && do { $HscOut = '-C='; next arg; }; # force using C compiler
3144 && do { push(@HsC_flags, $_); next arg };
3146 /^-funfold-casms-in-hi-file$/
3147 && do { push(@HsC_flags, $_); next arg };
3149 /^(-fmax-simplifier-iterations)(.*)$/
3150 && do { $Oopt_MaxSimplifierIterations = $1 . &grab_arg_arg(*Args,$1, $2);
3153 /^-fno-pedantic-bottoms$/
3154 && do { $Oopt_PedanticBottoms = ''; next arg; };
3156 /^-fno-pre-inlining$/
3157 && do { push(@HsC_flags, $_); next arg };
3159 /^-fdo-monad-eta-expansion$/
3160 && do { $Oopt_MonadEtaExpansion = $_; next arg; };
3162 /^-fno-let-from-(case|app|strict-let)$/ # experimental, really (WDP 95/10)
3163 && do { push(@HsC_flags, $_); next arg; };
3165 # --------------- Warnings etc. ------
3167 /^-fwarn-(.*)$/ && do { push(@HsC_flags, $_); next arg; };
3169 /^-fno-(.*)$/ && do { push(@HsC_antiflags, "-f$1");
3170 &squashHscFlag("-f$1");
3173 /^-W$/ && do { push(@HsC_flags, @MinusWOpts); next arg; };
3174 /^-Wall$/ && do { push(@HsC_flags, @MinusWallOpts); next arg; };
3175 /^(-Wnot|w)$/ && do { foreach (@Hsc_flags) {
3176 /^-fwarn-(.*)$/ && do { $_=''; };
3178 push(@HsC_antiflags, @StandardWarnings);
3181 # --------------- fun stuff ----------------
3183 /^-freport-compile$/ && do { push(@HsC_flags, $_); next arg; };
3185 # --------------- platform specific flags (for gcc mostly) ----------------
3187 /^-mlong-calls$/ && do { # for GCC for HP-PA boxes,
3188 # for 2.6.x..?, does not apply for 2.7.2
3190 unshift(@CcBoth_flags, ( $_ ));
3193 /^-m(v8|sparclite|cypress|supersparc|cpu=(cypress|supersparc))$/
3194 && do { # for GCC for SPARCs
3195 unshift(@CcBoth_flags, ( $_ ));
3198 /^-monly-([432])-regs/ && do { # for iX86 boxes only; no effect otherwise
3199 $StolenX86Regs = $1;
3202 #*************** ... and lots of debugging ones (form: -d* )
3204 # -d(no-)core-lint is done this way so it is turn-off-able.
3205 /^-dcore-lint/ && do { $CoreLint = '-dcore-lint'; next arg; };
3206 /^-dno-core-lint/ && do { $CoreLint = ''; next arg; };
3207 # Ditto for STG lint
3208 /^-dstg-lint/ && do { $StgLint = '-dstg-lint'; next arg; };
3209 /^-dno-stg-lint/ && do { $StgLint = ''; next arg; };
3211 /^-d(dump|ppr)-/ && do { push(@HsC_flags, $_); next arg; };
3212 /^-dverbose-(simpl|stg)/ && do { push(@HsC_flags, $_); next arg; };
3213 /^-dshow-passes/ && do { push(@HsC_flags, $_); next arg; };
3214 /^-dshow-rn-stats/ && do { push(@HsC_flags, $_); next arg; };
3215 /^-dshow-rn-trace/ && do { push(@HsC_flags, $_); next arg; };
3216 /^-dsource-stats/ && do { push(@HsC_flags, $_); next arg; };
3217 /^-dsimplifier-stats/ && do { push(@HsC_flags, $_); next arg; };
3218 /^-dstg-stats/ && do { $Oopt_StgStats = $_; next arg; };
3220 #*************** ... and now all these -R* ones for its runtime system...
3222 /^-Rscale-sizes?(.*)/ && do {
3223 $Scale_sizes_by = &grab_arg_arg(*Args,'-Rscale-sizes', $1);
3226 /^(-H|-Rmax-heapsize)(.*)/ && do {
3227 local($heap_size) = &grab_arg_arg(*Args,$1, $2);
3228 if ($heap_size =~ /(\d+)[Kk]$/) {
3229 $heap_size = $1 * 1000;
3230 } elsif ($heap_size =~ /(\d+)[Mm]$/) {
3231 $heap_size = $1 * 1000 * 1000;
3232 } elsif ($heap_size =~ /(\d+)[Gg]$/) {
3233 $heap_size = $1 * 1000 * 1000 * 1000;
3235 if ($heap_size <= 0) {
3236 print STDERR "$Pgm: resetting heap-size to zero!!! $heap_size\n";
3237 $Specific_heap_size = 0;
3239 # if several heap sizes given, take the largest...
3240 } elsif ($heap_size >= $Specific_heap_size) {
3241 $Specific_heap_size = $heap_size;
3243 print STDERR "$Pgm: ignoring heap-size-setting option ($_)...not the largest seen\n";
3247 /^(-K|Rmax-(stk|stack)size)(.*)/ && do {
3249 local($stk_size) = &grab_arg_arg(*Args,'-Rmax-stksize', $3);
3250 if ($stk_size =~ /(\d+)[Kk]$/) {
3251 $stk_size = $1 * 1000;
3252 } elsif ($stk_size =~ /(\d+)[Mm]$/) {
3253 $stk_size = $1 * 1000 * 1000;
3254 } elsif ($stk_size =~ /(\d+)[Gg]$/) {
3255 $stk_size = $1 * 1000 * 1000 * 1000;
3257 if ($stk_size <= 0) {
3258 print STDERR "$Pgm: resetting stack-size to zero!!! $stk_size\n";
3259 $Specific_stk_size = 0;
3261 # if several stack sizes given, take the largest...
3262 } elsif ($stk_size >= $Specific_stk_size) {
3263 $Specific_stk_size = $stk_size;
3265 print STDERR "$Pgm: ignoring stack-size-setting option ($flag $stk_size)...not the largest seen\n";
3269 /^-Rgc-stats$/ && do { $CollectingGCstats++;
3270 # the two RTSs do this diff ways; we will try to compensate
3273 /^-Rghc-timing/ && do { $CollectGhcTimings = 1; next arg; };
3275 #---------- C high-level assembler (gcc) -------------------------------
3276 /^-(Wall|ansi|pedantic)$/ && do { push(@CcBoth_flags, $_); next arg; };
3278 # -dgcc-lint is a useful way of making GCC very fussy.
3279 # From alan@spri.levels.unisa.edu.au (Alan Modra).
3280 /^-dgcc-lint$/ && do { push(@CcBoth_flags, '-Wall -Wpointer-arith -Wbad-function-cast -Wcast-qual -Wstrict-prototypes -Wmissing-prototypes -Wmissing-declarations -Wnested-externs'); next arg; };
3281 # An alternate set, from mark@sgcs.com (Mark W. Snitily)
3282 # -Wall -Wstrict-prototypes -Wmissing-prototypes -Wcast-align -Wshadow
3284 # inject "#include <wurble>" into the compiler's C output!
3286 /^-#include(.*)/ && do {
3287 local($to_include) = &grab_arg_arg(*Args,'-#include', $1);
3288 push(@CcInjects, "#include $to_include\n");
3291 #---------- Linker (gcc, really) ---------------------------------------
3293 /^-static$/ && do { $Static=1; push(@Ld_flags, $_); next arg; };
3294 /^-no-hs-main$/ && do { $NoHaskellMain=1; next arg; };
3296 #---------- mixed cc and linker magic ----------------------------------
3297 # this optimisation stuff is finally sorted out later on...
3299 /^-O2-for-C$/ && do { $MinusO2ForC = 1; next arg; };
3301 /^-O[1-2]?$/ && do {
3302 local($opt_lev) = ( /^-O2$/ ) ? 2 : 1; # max 'em
3303 $OptLevel = ( $opt_lev > $OptLevel ) ? $opt_lev : $OptLevel;
3305 $HscOut = '-C=' if $OptLevel == 2; # force use of C compiler
3308 /^-Onot$/ && do { $OptLevel = 0; next arg; }; # # set it to <no opt>
3310 /^-Ofile(.*)/ && do {
3312 local($ofile) = &grab_arg_arg(*Args,'-Ofile', $1);
3313 @HsC_minusO3_flags = ();
3315 open(OFILE, "< $ofile") || die "Can't open $ofile!\n";
3318 s/\#.*//; # death to comments
3319 s/[ \t]+//g; # death to whitespace
3320 next if /^$/; # ditto, blank lines
3321 s/([()*{}])/\\$1/g; # protect shell metacharacters
3323 push(@CcBoth_flags, $1);
3325 push(@HsC_minusO3_flags, $_);
3331 /^-debug$/ && do { # all this does is mark a .hc/.o as "debugging"
3332 # in the consistency info
3336 #---------- linking .a file --------------------------------------------
3338 /^-Main(.*)/ && do {
3339 # specifies main or mainPrimIO to be linked
3343 #---------- catch unrecognized flags -----------------------------------
3346 print STDERR "$Pgm: unrecognised option: $_\n";
3352 } # end of processArgs