2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1997
5 This is the driver script for the Glasgow Haskell compilation system.
6 It is written in \tr{perl}. The first section includes a long
7 ``usage'' message that describes how the driver is supposed to work.
9 %************************************************************************
11 \section[Driver-usage]{Usage message}
13 %************************************************************************
16 ($Pgm = $0) =~ s|.*/||;
17 $ShortUsage = "\nUsage: For basic information, try the `-help' option.\n";
18 $LongUsage = "\n" . <<EOUSAGE;
19 Use of the Glorious Haskell Compilation System driver:
21 $Pgm [command-line-options-and-input-files]
23 ------------------------------------------------------------------------
24 This driver ($Pgm) guides each input file through (some of the)
25 possible phases of a compilation:
27 - unlit: extract code from a "literate program"
28 - hscpp: run code through the C pre-processor (if -cpp flag given)
29 - hsc: run the Haskell compiler proper
30 - gcc: run the C compiler (if compiling via C)
31 - as: run the assembler
34 For each input file, the phase to START with is determined by the
36 - .lhs literate Haskell: unlit
37 - .hs illiterate Haskell: hsc
38 - .hc C from the Haskell compiler: gcc
39 - .c C not from the Haskell compiler: gcc
40 - .s assembly language: as
41 - other passed directly to the linker: ld
43 If no files are given on the command line, input is taken from
44 standard input, and processing is as for an .hs file. (All output is
45 to stdout or stderr, however).
47 The phase at which to STOP processing is determined by a command-line
49 -C stop after generating C (.hc output)
50 -E stop after generating preprocessed C (.i output)
51 -S stop after generating assembler (.s output)
52 -c stop after generating object files (.o output)
54 Other commonly-used options are:
56 -O An `optimising' package of compiler flags, for faster code
58 -prof Compile for cost-centre profiling
59 (add -auto for automagic cost-centres on top-level functions)
61 -fglasgow-exts Allow Glasgow extensions (unboxed types, etc.)
63 -H14m Increase compiler's heap size
65 -M Output the Makefile rules recording the
66 dependencies of a list of Haskell files.
67 (ghc driver just calls upon the help of a
68 compatible mkdependHS script to do the
71 The User's Guide has more information about GHC's *many* options.
73 Given the above, here are some TYPICAL invocations of $Pgm:
75 # compile a Haskell module to a .o file, optimising:
77 # link three .o files into an executable called "test":
78 % $Pgm -o test Foo.o Bar.o Baz.o
79 # compile a Haskell module to C (a .hc file), using a bigger heap:
80 % $Pgm -C -H16m Foo.hs
81 # compile Haskell-produced C (.hc) to assembly language:
83 ------------------------------------------------------------------------
87 %************************************************************************
89 \section[Driver-init]{Initialisation}
91 %************************************************************************
93 The driver script need to be told where to find these executables, so
94 in the course of building the driver `executable', make-variables holding
95 these are prepended to the de-litted version of this file. The variables are:
100 HOSTPLATFORM TARGETPLATFORM
102 PROJECTNAME PROJECTVERSION PROJECTPATCHLEVEL
106 bindir libdir datadir
110 GHC_LIB_DIR GHC_RUNTIME_DIR GHC_UTILS_DIR GHC_INCLUDE_DIR
112 GHC_OPT_HILEV_ASM GhcWithNativeCodeGen
114 GHC_UNLIT GHC_HSCPP GHC_HSC GHC_SYSMAN
118 WAY_*_NAME WAY_*_HC_OPTS
124 Establish what executables to run for the various phases, what the
125 default options are for those phases, and other similar boring stuff.
128 select(STDERR); $| = 1; select(STDOUT); # no STDERR buffering, please.
130 $TargetPlatform = $TARGETPLATFORM;
132 $TopPwd = "${TOP_PWD}";
133 $InstBinDirGhc = "${bindir}";
134 $InstLibDirGhc = "${libdir}";
135 $InstDataDirGhc = "${datadir}";
136 $InstSysLibDir = ( $INSTALLING ) ? "${InstLibDirGhc}/hslibs" : "$TopPwd/hslibs";
138 $Status = 0; # just used for exit() status
141 # set up signal handler
142 sub quit_upon_signal { &tidy_up_and_die(1, ''); }
143 $SIG{'INT'} = 'quit_upon_signal';
144 $SIG{'QUIT'} = 'quit_upon_signal';
146 # where to get "require"d .prl files at runtime (poor man's dynamic loading)
147 # (use LIB, not DATA, because we can't be sure of arch-independence)
148 @INC = ( ( $INSTALLING ) ? $InstLibDirGhc
149 : "$TopPwd/${CURRENT_DIR}" );
151 if ( $ENV{'TMPDIR'} ) { # where to make tmp file names
152 $Tmp_prefix = ($ENV{'TMPDIR'} . "/ghc$$");
154 print STDERR "TMPDIR has not been set to anything useful!\n" if (${TMPDIR} eq '');
155 $Tmp_prefix ="${TMPDIR}/ghc$$"; # TMPDIR set via Makefile when booting..
156 $ENV{'TMPDIR'} = ${TMPDIR}; # set the env var as well
159 @Files_to_tidy = (); # files we nuke in the case of abnormal termination
161 $Unlit = ( $INSTALLING ) ? "$InstLibDirGhc/unlit"
162 : "$TopPwd/${CURRENT_DIR}/${GHC_UNLIT}";
166 $Diff = $CONTEXT_DIFF;
171 $HsCpp = # but this is re-set to "cat" (after options) if -cpp not seen
172 ( $INSTALLING ) ? "$InstLibDirGhc/hscpp"
173 : "$TopPwd/${CURRENT_DIR}/${GHC_HSCPP}";
176 $genSPECS_flag = ''; # See ../utils/hscpp/hscpp.prl
177 $HsC = ( $INSTALLING ) ? "$InstLibDirGhc/hsc"
178 : "$TopPwd/${CURRENT_DIR}/${GHC_HSC}";
180 # For PVM fiends only
181 $SysMan = ( $INSTALLING ) ? "$InstLibDirGhc/SysMan"
182 : "$TopPwd/${CURRENT_DIR}/${GHC_SYSMAN}";
187 # HsC_rts_flags: if we want to talk to the LML runtime system
188 # NB: we don't use powers-of-2 sizes, because this may do
189 # terrible things to cache behavior.
191 $Specific_heap_size = 6 * 1000 * 1000;
192 $Specific_stk_size = 1000 * 1000;
193 $Scale_sizes_by = 1.0;
197 The variables set by @setupOptFlags@ represent parts of the
198 -O/-O2/etc ``templates,'' which are filled in later, using these.
199 These are the default values, which may be changed by user flags.
203 $Oopt_UnfoldingUseThreshold = '-fsimpl-uf-use-threshold3';
204 $Oopt_MaxSimplifierIterations = '-fmax-simplifier-iterations4';
205 $Oopt_PedanticBottoms = '-fpedantic-bottoms'; # ON by default
206 $Oopt_MonadEtaExpansion = '';
207 $Oopt_FinalStgProfilingMassage = '';
209 $Oopt_SpecialiseUnboxed = '';
210 $Oopt_DoSpecialise = ''; # ToDo:LATER: '-fspecialise';
211 $Oopt_FoldrBuild = 0; # *Off* by default!
212 $Oopt_FB_Support = ''; # was '-fdo-arity-expand';
213 # $Oopt_FoldrBuildWW = 0; # Off by default
214 $Oopt_FoldrBuildInline = ''; # was '-fdo-inline-foldr-build';
215 } # end of setupOptFlags
217 # Assign defaults to these right away.
221 Things to do with C compilers/etc:
223 $CcRegd = $GHC_OPT_HILEV_ASM;
224 @CcBoth_flags = ('-S'); # flags for *any* C compilation
228 # those for all files,
229 # those only for .c files;
230 # those only for .hc files
232 @CcRegd_flags = ('-ansi', '-D__STG_GCC_REGS__', '-D__STG_TAILJUMPS__');
233 @CcRegd_flags_c = ();
234 @CcRegd_flags_hc = ();
236 $As = ''; # "assembler" is normally GCC
239 $Lnkr = ''; # "linker" is normally GCC
242 # 'nm' is used for consistency checking (ToDo: mk-world-ify)
243 # ToDo: check the OS or something ("alpha" is surely not the crucial question)
244 $Nm = ($TargetPlatform =~ /^alpha-/) ? 'nm -B' : 'nm';
247 What options \tr{-user-setup-a} turn into (user-defined ``packages''
248 of options). Note that a particular user-setup implies a particular
249 Prelude ({\em including} its interface file(s)).
251 $BuildTag = ''; # default is sequential build w/ Appel-style GC
253 %BuildDescr = (# system ways begin
254 '', 'normal sequential',
258 '_mc', "$WAY_mc_NAME",
259 '_mr', "$WAY_mr_NAME",
260 '_mt', "$WAY_mt_NAME",
261 '_mp', "$WAY_mp_NAME",
262 '_mg', "$WAY_mg_NAME",
263 '_2s', "$WAY_2s_NAME",
264 '_1s', "$WAY_1s_NAME",
265 '_du', "$WAY_du_NAME",
283 '_B', "$WAY_B_NAME" );
285 # these are options that are "fed back" through the option processing loop
289 '_a', "$WAY_a_HC_OPTS",
290 '_b', "$WAY_b_HC_OPTS",
291 '_c', "$WAY_c_HC_OPTS",
292 '_d', "$WAY_d_HC_OPTS",
293 '_e', "$WAY_e_HC_OPTS",
294 '_f', "$WAY_f_HC_OPTS",
295 '_g', "$WAY_g_HC_OPTS",
296 '_h', "$WAY_h_HC_OPTS",
297 '_i', "$WAY_i_HC_OPTS",
298 '_j', "$WAY_j_HC_OPTS",
299 '_k', "$WAY_k_HC_OPTS",
300 '_l', "$WAY_l_HC_OPTS",
301 '_m', "$WAY_m_HC_OPTS",
302 '_n', "$WAY_n_HC_OPTS",
303 '_o', "$WAY_o_HC_OPTS",
304 '_A', "$WAY_A_HC_OPTS",
305 '_B', "$WAY_B_HC_OPTS",
308 '_p', "$WAY_p_HC_OPTS",
309 '_t', "$WAY_t_HC_OPTS",
310 '_u', "$WAY_u_HC_OPTS",
311 '_mc', "$WAY_mc_HC_OPTS",
312 '_mr', "$WAY_mr_HC_OPTS",
313 '_mt', "$WAY_mt_HC_OPTS",
314 '_mp', "$WAY_mp_HC_OPTS",
315 '_mg', "$WAY_mg_HC_OPTS",
316 '_2s', "$WAY_2s_HC_OPTS",
317 '_1s', "$WAY_1s_HC_OPTS",
318 '_du', "$WAY_B_HC_OPTS" );
320 # per-build code fragments which are eval'd
321 #%EvaldSetupOpts = ('', '', # this one must *not* be set!
323 # # profiled sequential
324 # '_p', 'push(@HsC_flags, \'-fscc-profiling\');
325 # push(@CcBoth_flags, \'-DPROFILING\');',
328 # #push(@CcBoth_flags, '-DPROFILING_DETAIL_COUNTS');
330 # # ticky-ticky sequential
331 # '_t', 'push(@HsC_flags, \'-fticky-ticky\');
332 # push(@CcBoth_flags, \'-DTICKY_TICKY\');',
334 ##OLD: # unregisterized (ToDo????)
338 # '_mc', '$StkChkByPageFaultOK = 0;
339 # push(@HsC_flags, \'-fconcurrent\');
340 # push(@HsCpp_flags,\'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\');
341 # push(@Cpp_define, \'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\');',
343 # # profiled concurrent
344 # '_mr', '$StkChkByPageFaultOK = 0;
345 # push(@HsC_flags, \'-fconcurrent\', \'-fscc-profiling\');
346 # push(@HsCpp_flags,\'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\');
347 # push(@Cpp_define, \'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\', \'-DPROFILING\');',
349 # # ticky-ticky concurrent
350 # '_mt', '$StkChkByPageFaultOK = 0;
351 # push(@HsC_flags, \'-fconcurrent\', \'-fticky-ticky\');
352 # push(@HsCpp_flags,\'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\');
353 # push(@Cpp_define, \'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\', \'-DTICKY_TICKY\');',
356 # '_mp', '$StkChkByPageFaultOK = 0;
357 # push(@HsC_flags, \'-fconcurrent\');
358 # push(@HsCpp_flags,\'-D__PARALLEL_HASKELL__\', \'-DPAR\');
359 # push(@Cpp_define, \'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\', \'-DPAR\');',
362 # '_mg', '$StkChkByPageFaultOK = 0;
363 # push(@HsC_flags, \'-fconcurrent\', \'-fgransim\');
364 # push(@HsCpp_flags,\'-D__GRANSIM__\', \'-DGRAN\');
365 # push(@Cpp_define, \'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\', \'-DGRAN\');',
367 # '_2s', 'push (@CcBoth_flags, \'-DGC2s\');',
368 # '_1s', 'push (@CcBoth_flags, \'-DGC1s\');',
369 # '_du', 'push (@CcBoth_flags, \'-DGCdu\');',
371 # '_a', '', # these user-way guys should not be set!
391 Import/include directories (\tr{-I} options) are sufficiently weird to
392 require special handling.
395 @Import_dir = ('.'); #-i things
396 @Include_dir = ('.'); #-I things; other default(s) stuck on AFTER option processing
398 # where to look for interface files (system hi's, i.e., prelude and hslibs)
399 @SysImport_dir = ( $INSTALLING )
400 ? ( "$InstLibDirGhc/imports" )
401 : ( "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/required"
402 , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/ghc"
403 , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/glaExts"
404 , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/concurrent" );
406 # We need to look in ghc/ and glaExts/ when searching for implicitly needed .hi files, but
407 # we should really *not* look there for explicitly imported modules.
409 $GhcVersionInfo = int ($PROJECTVERSION * 100);
410 $Haskell1Version = 4; # i.e., Haskell 1.4
413 @UserLibrary_dir= (); #-L things;...
414 @UserLibrary = (); #-l things asked for by the user
416 @SysLibrary_dir = ( ( $INSTALLING ) #-syslib things supplied by the system
418 : ( "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR"
419 , "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR/gmp"
420 , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR"
421 , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/cbits"
424 @SysLibrary = (); # will be built up as we go along
426 $TopClosureFile # defaults to 1.2 one; will be mangled later
427 = ( $INSTALLING) ? "$InstLibDirGhc/TopClosureXXXX.o"
428 : "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR/main/TopClosureXXXX.o";
430 # make depend for Haskell
432 = ( $INSTALLING ) ? "$InstBinDirGhc/mkdependHS"
433 : "$TopPwd/$CURRENT_DIR/$GHC_UTILS_DIR/mkdependHS/mkdependHS";
435 @MkDependHS_flags = ( );
437 # do_link flag should not be reset while rescanning the cmd-line.
439 $Specific_output_dir = ''; # set by -odir <dir>
440 $Specific_output_file = ''; # set by -o <file>; "-" for stdout
443 Function to initialise the per-compilation-unit globals that
444 are used to guide and control the invocation of the different phases.
447 sub initDriverGlobals {
449 # reset the following options:
450 # RTS flags to use while compiling
452 @HsP_flags = (); # these are the flags destined solely for
453 # the flex/yacc parser
458 The optimisations/etc to be done by the compiler are {\em normally}
459 expressed with a \tr{-O} (or \tr{-O2}) flag, or by its absence.
462 $OptLevel = 0; # no -O == 0; -O == 1; -O2 == 2; -Ofile == 3
463 $MinusO2ForC = 0; # set to 1 if -O2 should be given to C compiler
464 $StolenX86Regs = 4; # **HACK*** of the very worst sort
468 @CcBoth_flags = ('-S'); # flags for *any* C compilation
471 # GCC flags: those for all files, those only for .c files; those only for .hc files
472 @CcRegd_flags = ('-ansi', '-D__STG_GCC_REGS__', '-D__STG_TAILJUMPS__');
473 @CcRegd_flags_c = ();
474 @CcRegd_flags_hc = ();
476 @Import_dir = ('.'); #-i things
477 @Include_dir = ('.'); #-I things; other default(s) stuck on AFTER option processing
482 We are given a list of files with various presumably-known suffixes
483 (unknown-suffix files go straight to the linker). For each file, we
484 begin by assuming that we'll run every phase over it. However: (1)
485 global flags (\tr{-c}, \tr{-S}, etc.) tell us not to run any phase
486 past a certain point; and (2) the file's suffix tells us what phase to
487 start with. Linking is weird and kept track of separately.
489 Here are the initial defaults applied to all files:
491 $Cpp_flag_set = 0; # (hack)
492 $Only_preprocess_C = 0; # pretty hackish
493 $Only_generate_deps = 0; #
494 $PostprocessCcOutput = 0;
496 # native code-gen or via C?
497 $HaveNativeCodeGen = $GhcWithNativeCodeGen;
498 $HscOut = '-C='; # '-C=' ==> .hc output; '-S=' ==> .s output; '-N=' ==> neither
500 if $HaveNativeCodeGen && $TargetPlatform =~ /^(alpha|sparc)-/;
501 # TEMP: disable x86 if $HaveNativeCodeGen && $TargetPlatform =~ /^(i386|alpha|sparc)-/;
502 $ProduceHi = '-hifile=';
506 $CollectingGCstats = 0;
507 $CollectGhcTimings = 0;
508 $DEBUGging = ''; # -DDEBUG and all that it entails (um... not really)
509 $PROFing = ''; # set to p or e if profiling
510 $PROFgroup = ''; # set to group if an explicit -Ggroup specified
511 $PROFauto = ''; # set to relevant hsc flag if -auto or -auto-all
512 $PROFcaf = ''; # set to relevant hsc flag if -caf-all
513 $PROFignore_scc = ''; # set to relevant parser flag if explicit sccs ignored
514 $UNPROFscc_auto = ''; # set to relevant hsc flag if forcing auto sccs without profiling
515 $TICKYing = ''; # set to t if compiling for ticky-ticky profiling
516 $PARing = ''; # set to p if compiling for PAR
517 $CONCURing = ''; # set to c if compiling for CONCURRENT
518 $GRANing = ''; # set to g if compiling for GRAN
519 $StkChkByPageFaultOK = 1; # may be set to 0 (false) for some builds
520 $Specific_hi_file = ''; # set by -ohi <file>; "-" for stdout
521 $Specific_dump_file = ''; # set by -odump <file>; "-" for stdout
522 $Using_dump_file = 0;
524 $Osuffix = ''; # default: use the normal suffix for that kind of output
526 $HiSuffix_prelude = '';
527 $Do_recomp_chkr = 0; # don't use the recompilatio checker unless asked
528 $Do_cc = -1; # a MAGIC indeterminate value; will be set to 1 or 0.
531 $Keep_hc_file_too = 0;
532 $Keep_s_file_too = 0;
533 $UseGhcInternals = 0; # if 1, may use GHC* modules
536 $Dump_parser_output = 0;
538 $Dump_asm_splitting_info = 0;
539 $NoImplicitPrelude = 0;
542 } # end of initDriverGlobals (Sigh)
544 # we split the argv passed to the driver into three:
549 # and files to be linked...
557 We inject consistency-checking information into \tr{.hc} files (both
558 when created by the Haskell compiler and when compiled by the C
559 compiler), so that we can check that an executable is made from
560 consistently-built pieces. (The check is normally done just after
561 linking.) The checking is done by introducing/munging
562 \tr{what(1)}-style strings. Anyway, here are the relevant global
563 variables and their defaults:
565 $LinkChk = 1; # set to 0 if the link check should *not* be done
567 # major & minor version numbers; major numbers must always agree;
568 # minor disagreements yield a warning.
569 $HsC_major_version = 31;
570 $HsC_minor_version = 0;
571 $Cc_major_version = 36;
572 $Cc_minor_version = 0;
574 # options: these must always agree
575 $HsC_consist_options = ''; # we record, in this order:
576 # Build tag; debugging?
577 $Cc_consist_options = ''; # we record, in this order:
578 # Build tag; debugging?
581 %************************************************************************
583 \section[Driver-parse-argv]{Munge the command-line options}
585 %************************************************************************
587 Now slurp through the arguments.
590 #---------- user defined prelude ---------------------------------------
592 if (grep(/^-user-prelude$/, @ARGV)) {
594 # If ARGV contains -user-prelude we are compiling a piece of
595 # prelude for the user, probably with additional specialise pragmas
597 # We strip out the -O -f and -user-prelude flags provided on
598 # the command line and add the ones used to compile the prelude
599 # ToDo: get these options from a common definition in mkworld
601 # We also enable any options forced through with -user-prelude-force
603 # Hey, Check out this grep statement ;-) (PS)
605 @ARGV = grep((!/^-O/ && !/^-f/ && !/^-user-prelude$/) || s/^-user-prelude-force//,
609 '-fcompiling-ghc-internals=???', # ToDo!!!!
611 '-fshow-pragma-name-errs',
612 '-fshow-import-specs',
618 print STDERR "ghc: -user-prelude options:\n", "@ARGV", "\n";
621 &initDriverGlobals();
622 &splitCmdLine(@ARGV);
623 # Run through the cmd-line first time.
624 &processArgs(@Cmd_opts);
626 # Check to see if driver is only in the business
627 # to generate dependencies
628 if ( $Status == 0 && $Only_generate_deps ) {
630 push (@MkDependHS_flags, "-o$Osuffix") if $Osuffix;
631 push (@MkDependHS_flags, "-s$BuildTag") if $BuildTag;
632 local($to_do) = "$MkDependHS @MkDependHS_flags -- @Cmd_opts -- @Input_file" ;
633 &run_something($to_do, 'Haskell dependencies');
637 # if there are several input files,
638 # we don't allow \tr{-o <file>} or \tr{-ohi <file>} options...
639 # (except if linking, of course)
641 if ($#Input_file > 0 && ( ! $Do_lnkr )) {
642 if ( ($Specific_output_file ne '' && $Specific_output_file ne '-')
643 || ($Specific_hi_file ne '' && $Specific_hi_file ne '-') ) {
644 print STDERR "$Pgm: You can't use -o or -ohi options if you have multiple input files.\n";
645 print STDERR "\tPerhaps the -odir option will do what you want.\n";
650 # check for various pathological -o and -odir combinations...
651 if ($Specific_output_dir ne '' && $Specific_output_file ne '') {
652 if ($Specific_output_file eq '-') {
653 print STDERR "$Pgm: can't set output directory with -ohi AND have output to stdout\n";
655 } else { # amalgamate...
656 $Specific_output_file = "$Specific_output_dir/$Specific_output_file";
657 # ToDo: check we haven't got a junk name now...
658 $Specific_output_dir = ''; # reset
662 # crash and burn if there were errors
664 print STDERR $ShortUsage;
669 %************************************************************************
671 \section[Driver-post-argv-mangling]{Setup after reading options}
673 %************************************************************************
675 %************************************************************************
677 \subsection{Set up for optimisation level (\tr{-O} or whatever)}
679 %************************************************************************
681 We come now to the default ``wads of options'' that are turned on by
682 \tr{-O0} (do min optimisation), \tr{-O} (ordinary optimisation),
683 \tr{-O2} (aggressive optimisation), or no O-ish flag (compile speed is
686 The user can also specify his/her own list of options in a file; in
687 that case, the work is already done (see stuff about @minusO3@,
690 GHC allows very precise control of what happens during a compilation.
691 Core-to-Core and STG-to-STG passes can be run in any order, as many
692 times as you like. Individual transformations can be turned on or
695 Sadly, however, there are some interdependencies \& Things You Must
696 Not Do. Here is the list.
700 \item[\tr{-fspecialise}:]
701 The specialiser must have dependency-analysed input; but if you run
702 the simplifier to do this, you must not let it toss away unused
703 bindings! (The typechecker conveys some specialisation info via
704 ``unused'' bindings...)
706 \item[\tr{-ffloat-inwards}:]
707 Floating inwards should be done before strictness analysis, because
708 the latter will give better results.
710 \item[\tr{-fstatic-args}:]
711 The static-arguments-transformation pass {\em must} have the
712 simplifier run right after it.
714 \item[\tr{-fcalc-inlinings[12]}:]
715 Not required, but there may be slight gains by re-simplifying after
716 this is done. (You could then \tr{-fcalc-inlinings} again, just for
719 \item[\tr{-ffull-laziness}:]
720 The (outwards-)let-floater should be the {\em last} Core-to-Core pass
721 that's run. (Um, well, howzabout the simplifier just once more...)
726 \item[\tr{-fupdate-analysis}:]
727 It really really wants to be the last STG-to-STG pass that is run.
732 sub setupOptimiseFlags {
738 # '-falways-float-lets-from-lets', # no idea why this was here (WDP 95/09)
739 '-ffloat-lets-exposing-whnf',
740 '-ffloat-primops-ok',
742 # '-fdo-lambda-eta-expansion', # too complicated
744 # '-flet-to-case', # no strictness analysis, so...
745 $Oopt_PedanticBottoms,
746 # $Oopt_MonadEtaExpansion, # no thanks
747 '-fsimpl-uf-use-threshold0',
748 '-fessential-unfoldings-only',
749 # $Oopt_UnfoldingUseThreshold, # no thanks
750 $Oopt_MaxSimplifierIterations,
753 # '-ffull-laziness', # removed 95/04 WDP following Andr\'e's lead
755 $Oopt_FinalStgProfilingMassage
758 @HsC_minusO_flags # NOTE: used for *both* -O and -O2 (some conditional bits)
760 '-fdo-eta-reduction',
762 # initial simplify: mk specialiser happy: minimum effort please
766 '-fkeep-spec-pragma-ids', # required before specialisation
767 '-fsimpl-uf-use-threshold0',
768 '-fessential-unfoldings-only',
769 '-fmax-simplifier-iterations1',
770 $Oopt_PedanticBottoms,
773 ($Oopt_DoSpecialise) ? (
774 '-fspecialise-overloaded',
775 $Oopt_SpecialiseUnboxed,
779 '-fsimplify', # need dependency anal after specialiser ...
780 '\(', # need tossing before calc-inlinings ...
782 '-ffloat-lets-exposing-whnf',
783 '-ffloat-primops-ok',
787 # '-fdo-eta-reduction',
788 '-fdo-lambda-eta-expansion',
790 $Oopt_PedanticBottoms,
791 $Oopt_MonadEtaExpansion,
792 $Oopt_UnfoldingUseThreshold,
793 $Oopt_MaxSimplifierIterations,
796 #LATER: '-fcalc-inlinings1', -- pointless for 2.01
798 # ($Oopt_FoldrBuildWW) ? (
799 # '-ffoldr-build-ww-anal',
800 # '-ffoldr-build-worker-wrapper',
804 # '-ffloat-lets-exposing-whnf',
805 # '-ffloat-primops-ok',
809 # '-fdo-eta-reduction',
810 # '-fdo-lambda-eta-expansion',
812 # $Oopt_PedanticBottoms,
813 # $Oopt_MonadEtaExpansion,
814 # $Oopt_UnfoldingUseThreshold,
815 # $Oopt_MaxSimplifierIterations,
819 # this pass-ordering sequence was agreed by Simon and Andr\'e
820 # (WDP 94/07, 94/11).
823 ($Oopt_FoldrBuild) ? (
824 '-ffoldr-build-on', # desugar list comprehensions for foldr/build
828 '-fignore-inline-pragma', # **** NB!
829 '-fdo-foldr-build', # NB
831 '-ffloat-lets-exposing-whnf',
832 '-ffloat-primops-ok',
836 # '-fdo-eta-reduction',
837 '-fdo-lambda-eta-expansion', # After full laziness
839 $Oopt_PedanticBottoms,
840 $Oopt_MonadEtaExpansion,
841 $Oopt_UnfoldingUseThreshold,
842 $Oopt_MaxSimplifierIterations,
851 '-ffloat-lets-exposing-whnf',
852 '-ffloat-primops-ok',
856 '-fdo-eta-reduction',
857 '-fdo-lambda-eta-expansion',
859 ($Oopt_FoldrBuildInline),
860 # you need to inline foldr and build
861 ($Oopt_FoldrBuild) ? ('-fdo-foldr-build') : (),
862 # but do reductions if you see them!
863 $Oopt_PedanticBottoms,
864 $Oopt_MonadEtaExpansion,
865 $Oopt_UnfoldingUseThreshold,
866 $Oopt_MaxSimplifierIterations,
874 '-ffloat-lets-exposing-whnf',
875 '-ffloat-primops-ok',
879 # '-fdo-eta-reduction',
880 '-fdo-lambda-eta-expansion',
882 '-flet-to-case', # Aha! Only done after strictness analysis
883 $Oopt_PedanticBottoms,
884 $Oopt_MonadEtaExpansion,
885 $Oopt_UnfoldingUseThreshold,
886 $Oopt_MaxSimplifierIterations,
891 # Case-liberation for -O2. This should be after
892 # strictness analysis and the simplification which follows it.
896 # : "-fliberate-case -fsimplify \\( $Oopt_FB_Support -ffloat-lets-exposing-whnf -ffloat-primops-ok -fcase-of-case -fdo-case-elim -fcase-merge -fdo-eta-reduction -fdo-lambda-eta-expansion -freuse-con -flet-to-case $Oopt_PedanticBottoms $Oopt_MonadEtaExpansion $Oopt_UnfoldingUseThreshold $Oopt_MaxSimplifierIterations \\)" ),
898 # Final clean-up simplification:
903 '-ffloat-lets-exposing-whnf',
904 '-ffloat-primops-ok',
908 # '-fdo-eta-reduction',
909 '-fdo-lambda-eta-expansion',
912 '-fignore-inline-pragma', # **** NB!
913 $Oopt_FoldrBuildInline,
914 ($Oopt_FoldrBuild) ? ('-fdo-foldr-build') : (),
915 # but still do reductions if you see them!
916 $Oopt_PedanticBottoms,
917 $Oopt_MonadEtaExpansion,
918 $Oopt_UnfoldingUseThreshold,
919 $Oopt_MaxSimplifierIterations,
924 #LATER: '-fcalc-inlinings2', -- pointless for 2.01
929 $Oopt_FinalStgProfilingMassage,
935 # SPECIAL FLAGS for -O2
943 Sort out what we're going to do about optimising. First, the @hsc@
944 flags and regular @cc@ flags to worry about:
946 if ( $OptLevel <= 0 ) {
948 # for this level, we tell the parser -fignore-interface-pragmas
949 push(@HsC_flags, '-fignore-interface-pragmas');
950 # and tell the compiler not to produce them
951 push(@HsC_flags, '-fomit-interface-pragmas');
953 &add_Hsc_flags( @HsC_minusNoO_flags );
954 push(@CcBoth_flags, ($MinusO2ForC) ? '-O2' : '-O'); # not optional!
956 } elsif ( $OptLevel == 1 || $OptLevel == 2 ) {
958 &add_Hsc_flags( @HsC_minusO_flags );
959 push(@CcBoth_flags, ($MinusO2ForC || $OptLevel == 2) ? '-O2' : '-O'); # not optional!
960 # -O? to GCC is not optional! -O2 probably isn't worth it generally,
961 # but it *is* useful in compiling the garbage collectors (so said
962 # Patrick many moons ago...).
964 } else { # -Ofile, then...
966 &add_Hsc_flags( @HsC_minusO3_flags );
967 push(@CcBoth_flags, ($MinusO2ForC) ? '-O2' : '-O'); # possibly to be elaborated...
970 } # setupOptimiseFlags
974 %************************************************************************
976 \subsection{Check for consistency, etc.}
978 %************************************************************************
980 Sort out @$BuildTag@, @$PROFing@, @$CONCURing@, @$PARing@,
981 @$GRANing@, @$TICKYing@:
983 sub setupBuildFlags {
986 # PROFILING stuff after argv mangling:
988 # warn about any scc exprs found (in case scc used as identifier)
989 push(@HsP_flags, '-W');
991 # add -auto sccs even if not profiling !
992 push(@HsC_flags, $UNPROFscc_auto) if $UNPROFscc_auto;
995 push(@HsC_flags, $PROFauto) if $PROFauto;
996 push(@HsC_flags, $PROFcaf) if $PROFcaf;
997 #push(@HsC_flags, $PROFdict) if $PROFdict;
999 $Oopt_FinalStgProfilingMassage = '-fmassage-stg-for-profiling';
1001 push(@HsP_flags, (($PROFignore_scc) ? $PROFignore_scc : '-S'));
1003 if ( $SplitObjFiles ) {
1004 # can't split with cost centres -- would need global and externs
1005 print STDERR "$Pgm: WARNING: splitting objects when profiling will *BREAK* if any _scc_s are present!\n";
1006 # (but it's fine if there aren't any _scc_s around...)
1007 # $SplitObjFiles = 0; # unset
1008 #not an error: for now: $Status++;
1011 #if ( $BuildTag ne '' ) {
1012 # local($b) = $BuildDescr{$BuildTag};
1013 # if ($CONCURing eq 'c') { print STDERR "$Pgm: Can't mix $b with -concurrent.\n"; exit 1; }
1014 # if ($PARing eq 'p') { print STDERR "$Pgm: Can't mix $b with -parallel.\n"; exit 1; }
1015 # if ($GRANing eq 'g') { print STDERR "$Pgm: Can't mix $b with -gransim.\n"; exit 1; }
1016 # if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix $b with -ticky.\n"; exit 1; }
1018 # # ok to have a user-way profiling build
1019 # # eval the profiling opts ... but leave user-way BuildTag
1020 # if ($PROFing eq 'p') { &processArgs(split(' ', $SetupOpts{'_p'})); } # eval($EvaldSetupOpts{'_p'}); }
1022 if ( $PROFing eq 'p' ) {
1023 if ($PARing eq 'p') { print STDERR "$Pgm: Can't do profiling with -parallel.\n"; exit 1; }
1024 if ($GRANing eq 'g') { print STDERR "$Pgm: Can't do profiling with -gransim.\n"; exit 1; }
1025 if ($TICKYing eq 't') { print STDERR "$Pgm: Can't do profiling with -ticky.\n"; exit 1; }
1026 $BuildTag = ($CONCURing eq 'c') ? '_mr' : '_p' ; # possibly "profiled concurrent"...
1028 } elsif ( $CONCURing eq 'c' ) {
1029 if ($PARing eq 'p') { print STDERR "$Pgm: Can't mix -concurrent with -parallel.\n"; exit 1; }
1030 if ($GRANing eq 'g') { print STDERR "$Pgm: Can't mix -concurrent with -gransim.\n"; exit 1; }
1031 $BuildTag = ($TICKYing eq 't') ? '_mt' : '_mc' ; # possibly "ticky concurrent"...
1032 # "profiled concurrent" already acct'd for...
1034 } elsif ( $PARing eq 'p' ) {
1035 if ($GRANing eq 'g') { print STDERR "$Pgm: Can't mix -parallel with -gransim.\n"; exit 1; }
1036 if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix -parallel with -ticky.\n"; exit 1; }
1039 if ( $Do_lnkr && ( ! $ENV{'PVM_ROOT'} || ! $ENV{'PVM_ARCH'} )) {
1040 print STDERR "$Pgm: both your PVM_ROOT and PVM_ARCH environment variables must be set for linking under -parallel.\n";
1044 } elsif ( $GRANing eq 'g' ) {
1045 if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix -gransim with -ticky.\n"; exit 1; }
1048 } elsif ( $TICKYing eq 't' ) {
1054 After the sanity checks, add flags to the necessary parts of the driver pipeline:
1057 if ( $BuildTag ne '' ) { # something other than normal sequential...
1059 local($Tag) = "${BuildTag}";
1060 $Tag =~ s/_//; # move the underscore to the back
1062 $HscOut = '-C='; # must go via C
1063 &processArgs(split(' ', $SetupOpts{$BuildTag}));
1064 # eval($EvaldSetupOpts{$BuildTag});
1068 Decide what the consistency-checking options are in force for this run:
1071 $HsC_consist_options = "${BuildTag},${DEBUGging}";
1072 $Cc_consist_options = "${BuildTag},${DEBUGging}";
1075 # Funny place to put it, but why not.
1077 if ( $HiSuffix_prelude eq '' ) {
1078 local($Tag) = "${BuildTag}";
1080 $Tag = "${Tag}_" if $Tag ne '';
1081 $HiSuffix_prelude="${Tag}hi";
1083 push(@HsC_flags, "-hisuf-prelude=.${HiSuffix_prelude}"); # use appropriate Prelude .hi files
1084 push(@HsC_flags, "-hisuf=.${HiSuffix}");
1089 %************************************************************************
1091 \subsection{Add on machine-specific C-compiler flags}
1093 %************************************************************************
1095 Shove on magical machine-specific options. We use \tr{unshift} to
1096 stick them on the {\em front} of the arrays, so that ``later''
1097 user-specified flags can clobber them (e.g., \tr{-U__STG_REV_TBLS__}).
1099 Note: a few ``always apply'' flags were set at the very beginning.
1104 if ($TargetPlatform =~ /^alpha-/) {
1105 # we know how to *mangle* asm for alpha
1106 unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1107 unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK;
1108 unshift(@CcBoth_flags, ('-static'));
1110 } elsif ($TargetPlatform =~ /^hppa/) {
1111 # we know how to *mangle* asm for hppa
1112 unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1113 unshift(@CcBoth_flags, ('-static'));
1115 # We don't put in '-mlong-calls', because it's only
1116 # needed for very big modules (sigh), and we don't want
1117 # to hobble ourselves further on all the other modules
1120 # [Dated comment (gcc-2.6.x?), -mlong-calls is no longer
1121 # a supported gcc HPPA flag]
1122 unshift(@CcBoth_flags, ('-D_HPUX_SOURCE'));
1123 # ___HPUX_SOURCE, not _HPUX_SOURCE, is #defined if -ansi!
1124 # (very nice, but too bad the HP /usr/include files don't agree.)
1126 } elsif ($TargetPlatform =~ /^i386-/) {
1127 # we know how to *mangle* asm for X86
1128 unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1129 unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1'))
1130 if $StkChkByPageFaultOK;
1131 && $TargetPlatform !~ /nextstep/;
1132 # I do not know how to do STACK_CHECK_BY_PAGE_FAULT
1133 # on NeXTs (my fault, not theirs), so I don't.
1136 # -fno-defer-pop : basically the same game as for m68k
1138 # -fomit-frame-pointer : *must* ; because we're stealing
1139 # the fp (%ebp) for our register maps. *All* register
1140 # maps (in MachRegs.lh) must steal it.
1142 unshift(@CcRegd_flags_hc, '-fno-defer-pop');
1143 unshift(@CcRegd_flags, '-fomit-frame-pointer');
1144 unshift(@CcRegd_flags, "-DSTOLEN_X86_REGS=$StolenX86Regs");
1146 } elsif ($TargetPlatform =~ /^m68k-/) {
1147 # we know how to *mangle* asm for m68k
1148 unshift (@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1149 unshift (@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1'))
1150 if $StkChkByPageFaultOK;
1151 && $TargetPlatform !~ /nextstep/;
1152 # I do not know how to do STACK_CHECK_BY_PAGE_FAULT
1153 # on NeXTs (my fault, not theirs), so I don't.
1156 # -fno-defer-pop : for the .hc files, we want all the pushing/
1157 # popping of args to routines to be explicit; if we let things
1158 # be deferred 'til after an STGJUMP, imminent death is certain!
1160 # -fomit-frame-pointer : *don't*
1161 # It's better to have a6 completely tied up being a frame pointer
1162 # rather than let GCC pick random things to do with it.
1163 # (If we want to steal a6, then we would try to do things
1164 # as on iX86, where we *do* steal the frame pointer [%ebp].)
1166 unshift(@CcRegd_flags_hc, '-fno-defer-pop');
1167 unshift(@CcRegd_flags, '-fno-omit-frame-pointer');
1168 # maybe gives reg alloc a better time
1169 # also: -fno-defer-pop is not sufficiently well-behaved without it
1171 } elsif ($TargetPlatform =~ /^mips-/) {
1172 # we (hope to) know how to *mangle* asm for MIPSen
1173 unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1174 unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK;
1175 unshift(@CcBoth_flags, ('-static'));
1177 } elsif ($TargetPlatform =~ /^powerpc-/) {
1178 # we know how to *mangle* asm for PowerPC
1179 unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1180 unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK;
1181 unshift(@CcBoth_flags, ('-static')); # always easier to start with
1182 unshift(@CcRegd_flags, ('-finhibit-size-directive')); # avoids traceback tables
1184 } elsif ($TargetPlatform =~ /^sparc-/) {
1185 # we know how to *mangle* asm for SPARC
1186 unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1187 unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK;
1190 } # end of setupMachOpts
1193 Same unshifting magic, but for special linker flags.
1195 The configure script determines whether the object file symbol tables
1196 have a leading underscore, and sets @LeadingUnderscore@ accordingly.
1197 (The driver script `sees' the setting of the @LeadingUnderscore@
1198 by having the Makefile prepend it).
1202 local($uscore) = ( ${LeadingUnderscore} eq 'YES' ) ? '_' : '';
1206 '-u', "${uscore}Main_" . $Ld_main . '_closure',
1208 # What are these? -- SOF
1209 # , '-u', "${uscore}STbase_unsafePerformPrimIO_fast1"
1210 # , '-u', "${uscore}Prelude_Z91Z93_closure" # i.e., []
1211 # , '-u', "${uscore}Prelude_IZh_static_info"
1212 # , '-u', "${uscore}Prelude_False_inregs_info"
1213 # , '-u', "${uscore}Prelude_True_inregs_info"
1214 # , '-u', "${uscore}Prelude_CZh_static_info"
1215 # , '-u', "${uscore}DEBUG_REGS"
1217 ; # just for fun, now...
1219 } # end of setupLinkOpts
1223 %************************************************************************
1225 \subsection{Set up include paths and system-library enslurpment}
1227 %************************************************************************
1229 Now that we know what garbage-collector, etc., are required, we can
1230 finalise our list of libraries to slurp through, and generally Get
1235 # default includes must be added AFTER option processing
1236 if ( ! $INSTALLING ) {
1237 push (@Include_dir, "$TopPwd/${CURRENT_DIR}/${GHC_INCLUDE_DIR}");
1239 push (@Include_dir, "$InstLibDirGhc/includes");
1240 push (@Include_dir, "$InstLibDirGhc/includes");
1242 } # end of setupIncPaths
1247 push(@SysLibrary, ( '-lHS', '-lHS_cbits' )); # basic I/O and prelude stuff
1250 foreach $f (@SysLibrary) {
1251 next if $f =~ /_cbits/;
1252 $f .= $BuildTag if $f =~ /^-lHS/;
1255 # fiddle the TopClosure file name...
1256 $TopClosureFile =~ s/XXXX//;
1258 # Push library HSrts, plus boring clib bit
1259 push(@SysLibrary, "-lHSrts${BuildTag}");
1260 push(@SysLibrary, '-lHSclib');
1262 # RTS compiled with cygwin32, uses the WinMM API
1263 # to implement the itimers, since cygwin.dll does not
1264 # support it. Only reqd. for `ways' that use itimers.
1266 push(@SysLibrary, '-lwinmm') if $BuildTag ne '' && $TargetPlatform eq 'i386-unknown-cygwin32';
1268 # Push the pvm libraries
1269 if ($BuildTag eq '_mp') {
1270 $pvmlib = "$ENV{'PVM_ROOT'}/lib/$ENV{'PVM_ARCH'}";
1271 push(@SysLibrary, "-L$pvmlib", '-lpvm3', '-lgpvm3');
1272 if ( $ENV{'PVM_ARCH'} eq 'SUNMP' ) {
1273 push(@SysLibrary, '-lthread', '-lsocket', '-lnsl');
1274 } elsif ( $ENV{'PVM_ARCH'} eq 'SUN4SOL2' ) {
1275 push(@SysLibrary, '-lsocket', '-lnsl');
1279 # Push the GNU multi-precision arith lib; and the math library
1280 push(@SysLibrary, '-lgmp');
1281 push(@SysLibrary, '-lm');
1284 %************************************************************************
1286 \subsection{Check that this system was built to do what we are asking}
1288 %************************************************************************
1290 Before continuing we check that the appropriate build is available.
1293 #die "$Pgm: no BuildAvail?? $BuildTag\n" if $BuildDescr{$BuildTag} eq '' ; # sanity
1295 if ( $BuildDescr{$BuildTag} eq '' ) {
1296 print STDERR "$Pgm: a `", $BuildDescr{$BuildTag},
1297 "' \"build\" is not available with your GHC setup.\n";
1298 print STDERR "(It was not configured for it at your site.)\n";
1299 print STDERR $ShortUsage;
1303 } # end of setupSyslibs
1307 %************************************************************************
1309 \subsection{Final miscellaneous setup bits before we start going}
1311 %************************************************************************
1313 Record largest specific heapsize, if any.
1315 sub setupHeapStackSize {
1316 $Specific_heap_size = $Specific_heap_size * $Scale_sizes_by;
1317 push(@HsC_rts_flags, '-H'.$Specific_heap_size);
1318 $Specific_stk_size = $Specific_stk_size * $Scale_sizes_by;
1319 push(@HsC_rts_flags, "-K$Specific_stk_size");
1323 If no input or link files seen, then we let 'em feed in stdin; this is
1324 mainly for debugging.
1328 if ($#Input_file < 0 && $#Link_file < 0) {
1329 @Input_file = ( '-' );
1331 open(INF, "> $Tmp_prefix.hs") || &tidy_up_and_die(1,"Can't open $Tmp_prefix.hs\n");
1332 print STDERR "Enter your Haskell program, end with ^D (on a line of its own):\n";
1333 while (<>) { print INF $_; }
1334 close(INF) || &tidy_up_and_die(1,"Failed writing to $Tmp_prefix.hs\n");
1339 Tell the world who we are, if they asked.
1341 print STDERR "${PROJECTNAME}, version ${PROJECTVERSION}, patchlevel ${PROJECTPATCHLEVEL}\n"
1345 %************************************************************************
1347 \section[Driver-main-loop]{Main loop: Process input files, and link if required}
1349 %************************************************************************
1351 Process the input files; don't continue with linking if there are
1352 problems (global variable @$Status@ non-zero).
1354 foreach $ifile (@Input_file) {
1355 &ProcessInputFile($ifile);
1358 if ( $Status > 0 ) { # don't link if there were errors...
1359 print STDERR $ShortUsage;
1364 # append last minute flags linker and consistency flags
1371 Link if appropriate.
1374 local($libdirs) = '';
1376 # glue them together:
1377 push(@UserLibrary_dir, @SysLibrary_dir);
1379 $libdirs = '-L' . join(' -L',@UserLibrary_dir) if $#UserLibrary_dir >= 0;
1381 # for a linker, use an explicitly given one, or the going C compiler ...
1382 local($lnkr) = ( $Lnkr ) ? $Lnkr : $CcRegd;
1384 local($output) = ($Specific_output_file ne '') ? "-o $Specific_output_file" : '';
1385 @Files_to_tidy = ($Specific_output_file ne '') ? $Specific_output_file : 'a.out';
1387 local($to_do) = "$lnkr $Verbose @Ld_flags $output @Link_file $TopClosureFile $libdirs @UserLibrary @SysLibrary";
1388 &run_something($to_do, 'Linker');
1390 # finally, check the consistency info in the binary
1391 local($executable) = $Files_to_tidy[0];
1392 @Files_to_tidy = (); # reset; we don't want to nuke it if it's inconsistent
1395 # dynamically load consistency-chking code; then do it.
1396 require('ghc-consist.prl')
1397 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-consist.prl!\n");
1399 &chk_consistency_info ( $executable );
1402 # if PVM parallel stuff, we do truly weird things.
1403 # Essentially: (1) move the executable over to where PVM expects
1404 # to find it. (2) create a script in place of the executable
1405 # which will cause the program to be run, via SysMan.
1406 if ( $PARing eq 'p' ) {
1407 local($pvm_executable) = $executable;
1408 local($pvm_executable_base);
1410 if ( $pvm_executable !~ /^\// ) { # a relative path name: make absolute
1411 local($pwd) = `pwd`;
1413 $pwd =~ s/^\/tmp_mnt//;
1414 $pvm_executable = "$pwd/$pvm_executable";
1417 $pvm_executable =~ s|/|=|g; # make /s into =s
1418 $pvm_executable_base = $pvm_executable;
1420 $pvm_executable = $ENV{'PVM_ROOT'} . '/bin/' . $ENV{'PVM_ARCH'}
1421 . "/$pvm_executable";
1423 &run_something("$Rm -f $pvm_executable; $Cp -p $executable $pvm_executable && $Rm -f $executable", 'Moving binary to PVM land');
1425 # OK, now create the magic script for "$executable"
1426 open(EXEC, "> $executable") || &tidy_up_and_die(1,"$Pgm: couldn't open $executable to write!\n");
1427 print EXEC <<EOSCRIPT1;
1428 eval 'exec perl -S \$0 \${1+"\$@"}'
1429 if \$running_under_some_shell;
1430 # =!=!=!=!=!=!=!=!=!=!=!
1431 # This script is automatically generated: DO NOT EDIT!!!
1432 # Generated by Glasgow Haskell, version ${PROJECTVERSION} ${PROJECTPATCHLEVEL}
1434 \$pvm_executable = '$pvm_executable';
1435 \$pvm_executable_base = '$pvm_executable_base';
1436 \$SysMan = '$SysMan';
1439 print EXEC <<\EOSCRIPT2;
1440 # first, some magical shortcuts to run "commands" on the binary
1442 if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {
1444 system("$cmd $pvm_executable");
1448 # OK, really run it; process the args first
1449 $ENV{'PE'} = $pvm_executable_base;
1451 $nprocessors = 2; # the default
1455 # ToDo: handle --RTS
1456 args: while ($a = shift(@ARGV)) {
1457 if ( $a eq '+RTS' ) {
1459 } elsif ( $a eq '-RTS' ) {
1462 if ( $a eq '-d' && $in_RTS_args ) {
1464 } elsif ( $a =~ /^-N(\d+)/ && $in_RTS_args ) {
1467 push(@nonPVM_args, $a);
1471 local($return_val) = 0;
1472 system("$SysMan $debug $pvm_executable $nprocessors @nonPVM_args");
1474 system("mv $ENV{'HOME'}/$pvm_executable_base.???.gr .") if -f "$ENV{'HOME'}/$pvm_executable_base.001.gr";
1477 close(EXEC) || die "Failed closing $executable\n";
1478 chmod 0755, $executable;
1482 # that... that's all, folks!
1484 exit $Status; # will still be 0 if all went well
1487 %************************************************************************
1489 \section[Driver-do-one-file]{How to process a single input file}
1491 %************************************************************************
1494 sub ProcessInputFile {
1495 local($ifile) = @_; # input file name
1496 local($ifile_root); # root of or basename of input file
1497 local($ofile_target); # ultimate output file we hope to produce
1498 # from input file (need to know for recomp
1499 # checking purposes)
1500 local($hifile_target);# ditto (but .hi file)
1503 Handle the weirdity of input from stdin.
1505 if ($ifile ne '-') {
1506 ($ifile_root = $ifile) =~ s/\.[^\.\/]+$//;
1507 $ofile_target = # may be reset later...
1508 ($Specific_output_file ne '' && ! $Do_lnkr)
1509 ? $Specific_output_file
1510 : &odir_ify($ifile_root, 'o');
1511 $hifile_target= ($Specific_hi_file ne '')
1513 : "$ifile_root.$HiSuffix"; # ToDo: odirify?
1514 # NB: may change if $ifile_root isn't module name (??)
1516 $ifile = "$Tmp_prefix.hs"; # we know that's where we put the input
1517 $ifile_root = '_stdin';
1518 $ofile_target = '_stdout'; # gratuitous?
1519 $hifile_target= '_stdout'; # ditto?
1523 We need to decide what phases of the compilation system we will run
1524 over this file. The defaults are the ones established when processing
1525 flags. (That established what the last phase run for all files is.)
1527 We do the pre-recompilation-checker phases here; the rest later.
1531 Look at the suffix and decide what initial phases of compilation may
1532 be dropped off for this file. Also the rather boring business of
1533 which files are coming-in/going-out.
1535 Again, we'll do the post-recompilation-checker parts of this later.
1537 local($do_lit2pgm) = ($ifile =~ /\.lhs$/) ? 1 : 0;
1538 local($do_hscpp) = 1; # but "hscpp" might really be "cat"
1541 # names of the files to stuff between phases
1542 # defaults are temporaries
1543 local($in_lit2pgm) = $ifile;
1544 local($lit2pgm_hscpp) = "$Tmp_prefix.lpp";
1545 local($hscpp_hsc) = "$Tmp_prefix.cpp";
1546 local($hsc_hi) = "$Tmp_prefix.hi";
1547 local($cc_as_o) = "${Tmp_prefix}_o.s"; # temporary for raw .s file if opt C
1548 local($cc_as) = "$Tmp_prefix.s"; # mangled or hsc-produced .s code
1549 local($as_out) = $ofile_target;
1551 local($is_hc_file) = 1; #Is the C code .hc or .c? Assume .hc for now
1553 $lit2pgm_hscpp = $ifile if ($ifile =~ /\.hs$/);
1555 # OK, let's strip off some literate junk:
1556 &runLit2pgm($in_lit2pgm, $lit2pgm_hscpp) if ($ifile =~ /\.lhs$/);
1560 # Scan the top of the de-litted file for {-# OPTIONS #-} pragmas
1561 &check_for_source_options($lit2pgm_hscpp);
1562 # options found in the source file take a back seat, i.e., we scan
1563 # them first. Only process the command line again if source file
1564 # contained anything of interest *or* there's more than one
1565 # input file (we have to reset the options).
1567 if ( $#Input_file >= 0 || $#File_options >= 0) {
1568 @File_options = (@File_options, @Cmd_opts);
1570 # Now process the command line
1571 &initDriverGlobals();
1572 &processArgs(@File_options);
1575 # Having got the effective command line scanned, set up
1576 # the various options in prep for some real work.
1578 # check the sanity of the BuildTag we're about to use,
1579 # and if needs be, add some more flags and setup to
1580 # the different phases.
1583 &setupOptimiseFlags();
1586 &setupHeapStackSize();
1589 # These two variables need to be set after the
1590 # command-line has been processed and the build options
1591 # have be seen set up. This is because command-line options
1592 # can control whether to compile vias C or not.
1594 local($do_cc) = ( $Do_cc != -1) # i.e., it was set explicitly
1596 : ( ($HscOut eq '-C=') ? 1 : 0 );
1597 local($do_as) = $Do_as;
1598 local($hsc_out) = ( $HscOut eq '-C=' ) ? "$Tmp_prefix.hc" : "$Tmp_prefix.s" ;
1600 if ($ifile =~ /.lhs$/ || $ifile =~ /.hs$/ ) {
1602 } elsif ($ifile =~ /\.hc$/ || $ifile =~ /_hc$/ ) { # || $ifile =~ /\.$Isuffix$/o) # ToDo: better
1603 $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
1605 } elsif ($ifile =~ /\.c$/) {
1606 $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
1607 $hsc_out = $ifile; $is_hc_file = 0;
1608 } elsif ($ifile =~ /\.s$/) {
1609 $do_hscpp = 0; $do_hsc = 0; $do_cc = 0;
1611 } else { # don't know what it is, but nothing to do herein...
1612 $do_hscpp = 0; $do_hsc = 0; $do_cc = 0; $do_as = 0;
1615 # hack to avoid running hscpp
1616 $HsCpp = $Cat if ! $Cpp_flag_set;
1618 &runHscpp($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc)
1622 We now think about whether to run hsc/cc or not (when hsc produces .s
1623 stuff, it effectively takes the place of both phases).
1625 To get the output file name right: for each phase that we are {\em
1626 not} going to run, set its input (i.e., the output of its preceding
1627 phase) to @"$ifile_root.<suffix>"@.
1629 local($going_interactive) = $HscOut eq '-N=' || $ifile_root eq '_stdin';
1632 # Warning issued if -keep-hc-file-too is used without
1633 # -fvia-C (or the equivalent)
1635 if ( $HscOut ne '-C=' && $Keep_hc_file_too ) {
1636 print STDERR "Warning: Native code generator to be used, -keep-hc-file-too will be ignored\n";
1639 if (! $do_cc && ! $do_as) { # stopping after hsc
1640 $hsc_out = ($Specific_output_file ne '')
1641 ? $Specific_output_file
1642 : &odir_ify($ifile_root, ($HscOut eq '-C=') ? 'hc' : 's');
1644 $ofile_target = $hsc_out; # reset
1647 if (! $do_as) { # stopping after gcc (or hsc)
1648 $cc_as = ($Specific_output_file ne '')
1649 ? $Specific_output_file
1650 : &odir_ify($ifile_root, ( $Only_preprocess_C ) ? 'i' : 's');
1652 $ofile_target = $cc_as; # reset
1658 Now the Haskell compiler, C compiler, and assembler
1662 &runHscAndProcessInterfaces( $ifile, $hscpp_hsc, $ifile_root,
1663 $ofile_target, $hifile_target);
1667 &runGcc ($is_hc_file, $hsc_out, $cc_as_o);
1668 &runMangler($is_hc_file, $cc_as_o, $cc_as, $ifile_root);
1671 &split_asm_file($cc_as) if $do_as && $SplitObjFiles;
1673 &runAs($as_out, $ifile_root) if $do_as;
1676 Finally, decide what to queue up for linker input.
1678 # tentatively assume we will eventually produce linker input:
1679 push(@Link_file, &odir_ify($ifile_root, 'o'));
1681 #ToDo: local($or_isuf) = ($Isuffix eq '') ? '' : "|$Isuffix";
1683 if ( $ifile !~ /\.(lhs|hs|hc|c|s)$/ && $ifile !~ /_hc$/ ) {
1684 print STDERR "$Pgm: don't recognise suffix on `$ifile'; passing it through to linker\n"
1685 if $ifile !~ /\.a$/;
1687 # oops; we tentatively pushed the wrong thing; fix & do the right thing
1688 pop(@Link_file); push(@Link_file, $ifile);
1692 } # end of ProcessInputFile
1695 %************************************************************************
1697 \section[Driver-run-phases]{Routines to run the various phases}
1699 %************************************************************************
1703 local($in_lit2pgm, $lit2pgm_hscpp) = @_;
1705 local($to_do) = "echo '#line 1 \"$in_lit2pgm\"' > $lit2pgm_hscpp && ".
1706 "$Unlit @Unlit_flags $in_lit2pgm - >> $lit2pgm_hscpp";
1707 @Files_to_tidy = ( $lit2pgm_hscpp );
1709 &run_something($to_do, 'literate pre-processor');
1715 local($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc) = @_;
1719 if ($HsCpp eq $Cat) {
1720 $to_do = "echo '#line 1 \"$in_lit2pgm\"' > $hscpp_hsc && ".
1721 "$HsCpp $lit2pgm_hscpp >> $hscpp_hsc";
1722 @Files_to_tidy = ( $hscpp_hsc );
1723 &run_something($to_do, 'Ineffective C pre-processor');
1725 local($includes) = '-I' . join(' -I',@Include_dir);
1726 $to_do = "echo '#line 1 \"$in_lit2pgm\"' > $hscpp_hsc && ".
1727 "$HsCpp $Verbose $genSPECS_flag @HsCpp_flags -D__HASKELL1__=$Haskell1Version -D__GLASGOW_HASKELL__=$GhcVersionInfo $includes $lit2pgm_hscpp >> $hscpp_hsc";
1728 @Files_to_tidy = ( $hscpp_hsc );
1729 &run_something($to_do, 'Haskellised C pre-processor');
1736 sub runHscAndProcessInterfaces {
1737 local($ifile, $hscpp_hsc, $ifile_root, $ofile_target, $hifile_target) = @_;
1739 # $ifile is the original input file
1740 # $hscpp_hsc post-unlit, post-cpp, etc., input file
1741 # $ifile_root input filename minus suffix
1742 # $ofile_target the output file that we ultimately hope to produce
1743 # $hifile_target the .hi file ... (ditto)
1745 local($source_unchanged) = 1;
1747 # Check if the source file is up to date relative to the target; in
1748 # that case we say "source is unchanged" and let the compiler bail out
1749 # early if the import usage information allows it.
1751 ($i_dev,$i_ino,$i_mode,$i_nlink,$i_uid,$i_gid,$i_rdev,$i_size,
1752 $i_atime,$i_mtime,$i_ctime,$i_blksize,$i_blocks) = stat($ifile);
1754 if ( ! -f $ofile_target ) {
1755 # print STDERR "$Pgm:compile:Output file $ofile_target doesn't exist\n";
1756 $source_unchanged = 0;
1759 ($o_dev,$o_ino,$o_mode,$o_nlink,$o_uid,$o_gid,$o_rdev,$o_size,
1760 $o_atime,$o_mtime,$o_ctime,$o_blksize,$o_blocks) = stat(_); # stat info from -f test
1762 if ( ! -f $hifile_target ) {
1763 # print STDERR "$Pgm:compile:Interface file $hifile_target doesn't exist\n";
1764 $source_unchanged = 0;
1767 ($hi_dev,$hi_ino,$hi_mode,$hi_nlink,$hi_uid,$hi_gid,$hi_rdev,$hi_size,
1768 $hi_atime,$hi_mtime,$hi_ctime,$hi_blksize,$hi_blocks) = stat(_); # stat info from -f test
1770 if ($i_mtime > $o_mtime) {
1771 # print STDERR "$Pgm:recompile:Input file $ifile newer than $ofile_target\n";
1772 $source_unchanged = 0;
1775 # So if source_unchanged is still "1", we pass on the good news to the compiler
1776 # The -recomp flag can disable this, forcing recompilation
1777 if ($Do_recomp_chkr && $source_unchanged) {
1778 push(@HsC_flags, '-fsource-unchanged');
1783 &runHsc($ifile_root, $hsc_out, $hsc_hi, $going_interactive);
1785 # See if it bailed out early, saying nothing needed doing.
1786 # We work this out by seeing if it created an output .hi file
1788 if ( ! -f $hsc_hi ) {
1789 # Doesn't exist, so we bailed out early.
1790 # Tell the C compiler and assembler not to run
1791 $do_cc = 0; $do_as = 0;
1793 # Update dependency info, touch both object file and
1794 # interface file, so that the following invariant is
1797 # a dependent module's interface file should after recompilation
1798 # checking be newer than the interface files of its imports.
1800 # That is, if module A's interface file changes, then module B
1801 # (which import from A) needs to be checked.
1802 # If A's change does not affect B, which causes the compiler to bail
1803 # out early, we still need to touch the interface file of B. The reason
1804 # for this is that B may export A's interface.
1806 &run_something("touch $ofile_target $hifile_target",
1807 "Touch $ofile_target $hifile_target, to propagate dependencies");
1811 # Didn't bail out early (new .hi file) so we thunder on
1813 # If non-interactive, heave in the consistency info at the end
1814 # NB: pretty hackish (depends on how $output is set)
1815 if ( ! $going_interactive ) {
1816 if ( $HscOut eq '-C=' ) {
1817 $to_do = "echo 'static char ghc_hsc_ID[] = \"\@(#)hsc $ifile\t$HsC_major_version.$HsC_minor_version,$HsC_consist_options\";' >> $hsc_out";
1819 } elsif ( $HscOut eq '-S=' ) {
1820 local($consist) = "hsc.$ifile.$HsC_major_version.$HsC_minor_version.$HsC_consist_options";
1821 $consist =~ s/,/./g;
1822 $consist =~ s/\//./g;
1823 $consist =~ s/-/_/g;
1824 $consist =~ s/[^A-Za-z0-9_.]/ZZ/g; # ToDo: properly?
1825 $to_do = "echo '\n\t.text\n$consist:' >> $hsc_out";
1827 &run_something($to_do, 'Pin on Haskell consistency info');
1831 # Interface-handling is important enough to live off by itself
1832 require('ghc-iface.prl')
1833 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-iface.prl!\n");
1835 &postprocessHiFile($hsc_hi, $hifile_target, $going_interactive);
1837 # save a copy of the .hc file, even if we are carrying on...
1838 if ($HscOut eq '-C=' && $do_cc && $Keep_hc_file_too) {
1839 local($to_do) = "$Rm $ifile_root.hc; $Cp $hsc_out $ifile_root.hc";
1840 &run_something($to_do, 'Saving copy of .hc file');
1843 # save a copy of the .s file, even if we are carrying on...
1844 if ($HscOut eq '-S=' && $do_as && $Keep_s_file_too) {
1845 local($to_do) = "$Rm $ifile_root.s; $Cp $hsc_out $ifile_root.s";
1846 &run_something($to_do, 'Saving copy of .s file');
1849 # if we're going to split up object files,
1850 # we inject split markers into the .hc file now
1851 if ( $HscOut eq '-C=' && $SplitObjFiles ) {
1852 &inject_split_markers ( $hsc_out );
1861 local($ifile_root, $hsc_out, $hsc_hi, $going_interactive) = @_;
1863 # prepend comma to HsP flags (so hsc can tell them apart...)
1864 foreach $a ( @HsP_flags ) { $a = ",$a" unless $a =~ /^,/; }
1866 &makeHiMap() unless $HiMapDone;
1867 # print STDERR "HiIncludes: $HiIncludeString\n";
1868 push(@HsC_flags, "-himap=$HiIncludeString");
1869 # push(@HsC_flags, "-himap=$HiMapFile");
1871 # here, we may produce .hc/.s and/or .hi files
1872 local($output) = '';
1873 @Files_to_tidy = ();
1875 if ( $going_interactive ) {
1876 # don't need .hi unless going to show it on stdout:
1877 $ProduceHi = '-nohifile=' if ! $HiOnStdout;
1878 $do_cc = 0; $do_as = 0; $Do_lnkr = 0; # and we won't go any further...
1881 # set up for producing output/.hi; note that flag twiddling
1882 # may mean that nothing will actually be produced:
1883 $output = "$ProduceHi$hsc_hi $HscOut$hsc_out";
1884 @Files_to_tidy = ( $hsc_hi, $hsc_out );
1886 # if we're compiling foo.hs, we want the GC stats to end up in foo.stat
1887 if ( $CollectingGCstats ) {
1888 push(@HsC_rts_flags, "-S$ifile_root.stat");
1889 push(@Files_to_tidy, "$ifile_root.stat");
1892 if ( $CollectGhcTimings ) { # assume $RTS_style eq 'ghc'
1893 # emit nofibbish time/bytes-alloc stats to stderr;
1894 # see later .stat file post-processing
1895 push(@HsC_rts_flags, "-s$Tmp_prefix.stat");
1896 push(@Files_to_tidy, "$Tmp_prefix.stat");
1900 if ($Specific_dump_file ne '') {
1901 $dump = "2>> $Specific_dump_file";
1902 $Using_dump_file = 1;
1906 $to_do = "$HsC @HsP_flags ,$hscpp_hsc $dump @HsC_flags $CoreLint $StgLint $Verbose $output +RTS @HsC_rts_flags";
1907 &run_something($to_do, 'Haskell compiler');
1909 # finish business w/ nofibbish time/bytes-alloc stats
1910 &process_ghc_timings() if $CollectGhcTimings;
1914 Use \tr{@Import_dir} and \tr{@SysImport_dir} to make a tmp file
1915 of (module-name, pathname) pairs, one per line, separated by a space.
1920 $HiIncludeString = (); # dir1:dir2:dir3, to pass to GHC
1924 # collect in %HiMap; write later; also used elsewhere in driver
1926 local($mod, $path, $d, $e);
1928 # reset the global variables:
1932 $HiIncludeString = (); # dir1:dir2:dir3, to pass to GHC
1934 foreach $d ( @Import_dir ) {
1935 if ($HiIncludeString) { $HiIncludeString = "$HiIncludeString:$d";
1936 } else { $HiIncludeString = $d; }
1938 # The compiler does the searching now
1940 # opendir(DIR, $d) || &tidy_up_and_die(1,"$Pgm: error when reading directory: $d\n");
1941 # local(@entry) = readdir(DIR);
1942 # foreach $e ( @entry ) {
1943 # next unless $e =~ /\b([A-Z][A-Za-z0-9_]*)\.${HiSuffix_prelude}$/o;
1946 # $path =~ s,^\./,,;
1948 # if ( ! defined($HiMap{$mod}) ) {
1949 # $HiMap{$mod} = $path;
1951 # &already_mapped_err($mod, $HiMap{$mod}, $path);
1954 # closedir(DIR); # || &tidy_up_and_die(1,"$Pgm: error when closing directory: $d\n");
1957 foreach $d ( @SysImport_dir ) {
1958 if ($HiIncludeString) { $HiIncludeString = "$HiIncludeString:$d";
1959 } else { $HiIncludeString = $d; }
1961 # opendir(DIR, $d) || &tidy_up_and_die(1,"$Pgm: error when reading directory: $d\n");
1962 # local(@entry) = readdir(DIR);
1963 # foreach $e ( @entry ) {
1964 # next unless $e =~ /([A-Z][A-Za-z0-9_]*)\.$HiSuffix$/o;
1965 # next if $NoImplicitPrelude && $e =~ /Prelude\.$HiSuffix$/o;
1969 # $path =~ s,^\./,,;
1971 # if ( ! defined($HiMap{$mod}) ) {
1972 # $HiMap{$mod} = $path;
1973 # } elsif ( $mod ne 'Main' ) { # saves useless warnings...
1974 # &already_mapped_err($mod, $HiMap{$mod}, $path);
1977 # closedir(DIR); # || &tidy_up_and_die(1,"$Pgm: error when closing directory: $d\n");
1981 # Not currently used:
1983 # $HiMapFile = "$Tmp_prefix.himap";
1984 # unlink($HiMapFile);
1985 # open(HIMAP, "> $HiMapFile") || &tidy_up_and_die(1,"$Pgm: can't open $HiMapFile\n");
1986 # foreach $d (keys %HiMap) {
1987 # print HIMAP $d, ' ', $HiMap{$d}, "\n";
1989 # close(HIMAP) || &tidy_up_and_die(1,"$Pgm: error when closing $HiMapFile\n");
1994 sub already_mapped_err {
1995 local($mod, $mapped_to, $path) = @_;
1997 # OK, it isn't really an error if $mapped_to and $path turn
1998 # out to be the same thing.
1999 ($m_dev,$m_ino,$m_mode,$m_nlink,$m_uid,$m_gid,$m_rdev,$m_size,
2000 $m_atime,$m_mtime,$m_ctime,$m_blksize,$m_blocks) = stat($mapped_to);
2001 ($p_dev,$p_ino,$p_mode,$p_nlink,$p_uid,$p_gid,$p_rdev,$p_size,
2002 $p_atime,$p_mtime,$p_ctime,$p_blksize,$p_blocks) = stat($path);
2004 return if $m_ino == $p_ino; # same inode number
2006 print STDERR "$Pgm: module $mod already mapped to $mapped_to";
2007 print STDERR ";\n\tignoring: $path\n";
2011 %************************************************************************
2013 \section[Driver-misc-utils]{Miscellaneous utilities}
2015 %************************************************************************
2017 %************************************************************************
2019 \subsection[Driver-odir-ify]{@odir_ify@: Mangle filename if \tr{-odir} set}
2021 %************************************************************************
2025 local($ofile,$def_suffix) = @_;
2027 return(($Osuffix eq '') ? "$ofile.$def_suffix" : "$ofile.$Osuffix" );
2031 local($orig_file, $def_suffix) = @_;
2032 if ($Specific_output_dir eq '') { # do nothing
2033 &osuf_ify($orig_file, $def_suffix);
2035 local ($orig_file_only);
2036 ($orig_file_only = $orig_file) =~ s|.*/||;
2037 &osuf_ify("$Specific_output_dir/$orig_file_only",$def_suffix);
2044 local($is_hc_file, $hsc_out, $cc_as_o) = @_;
2046 local($includes) = '-I' . join(' -I', @Include_dir);
2049 local($c_flags) = "@CcBoth_flags";
2050 local($ddebug_flag) = ( $DEBUGging ) ? '-DDEBUG' : '';
2052 # "input" files to use that are not in some weird directory;
2053 # to help C compilers grok .hc files [ToDo: de-hackify]
2054 local($cc_help) = "ghc$$.c";
2055 local($cc_help_s) = "ghc$$.s";
2058 $s_output = ($is_hc_file || $TargetPlatform =~ /^(hppa|i386)/) ? $cc_as_o : $cc_as;
2059 $c_flags .= " @CcRegd_flags";
2060 $c_flags .= ($is_hc_file) ? " @CcRegd_flags_hc" : " @CcRegd_flags_c";
2062 # C compiler won't like the .hc extension. So we create
2063 # a tmp .c file which #include's the needful.
2064 open(TMP, "> $cc_help") || &tidy_up_and_die(1,"$Pgm: failed to open `$cc_help' (to write)\n");
2065 if ( $is_hc_file ) {
2067 #ifdef __STG_GCC_REGS__
2068 # if ! (defined(MAIN_REG_MAP) || defined(MARK_REG_MAP) || defined(SCAN_REG_MAP) || defined(SCAV_REG_MAP) || defined(FLUSH_REG_MAP))
2069 # define MAIN_REG_MAP
2072 #include "stgdefs.h"
2074 # user may have asked for #includes to be injected...
2075 print TMP @CcInjects if $#CcInjects >= 0;
2077 # heave in the consistency info
2078 print TMP "static char ghc_cc_ID[] = \"\@(#)cc $ifile\t$Cc_major_version.$Cc_minor_version,$Cc_consist_options\";\n";
2080 # and #include the real source
2081 print TMP "#include \"$hsc_out\"\n";
2082 close(TMP) || &tidy_up_and_die(1,"Failed writing to $cc_help\n");
2084 local($to_do) = "$cc $Verbose $ddebug_flag $c_flags @Cpp_define -D__HASKELL1__=$Haskell1Version $includes $cc_help > $Tmp_prefix.ccout 2>&1 && ( if [ $cc_help_s != $s_output ] ; then mv $cc_help_s $s_output ; else exit 0 ; fi )";
2085 # note: __GLASGOW_HASKELL__ is pointedly *not* #defined at the C level.
2086 if ( $Only_preprocess_C ) { # HACK ALERT!
2087 $to_do =~ s/ -S\b//g;
2089 @Files_to_tidy = ( $cc_help, $cc_help_s, $s_output );
2090 $PostprocessCcOutput = 1; # hack, dear hack...
2091 &run_something($to_do, 'C compiler');
2092 $PostprocessCcOutput = 0;
2093 unlink($cc_help, $cc_help_s);
2099 local($is_hc_file, $cc_as_o, $cc_as, $ifile_root) = @_;
2101 if ( $is_hc_file ) {
2102 # dynamically load assembler-fiddling code, which we are about to use:
2103 require('ghc-asm.prl')
2104 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm.prl!\n");
2107 print STDERR `cat $cc_as_o` if $Dump_raw_asm; # to stderr, before mangling
2110 # post-process the assembler [.hc files only]
2111 &mangle_asm($cc_as_o, $cc_as);
2115 #OLD: local($target) = 'oops';
2116 #OLD: $target = '-alpha' if $TargetPlatform =~ /^alpha-/;
2117 #OLD: $target = '-hppa' if $TargetPlatform =~ /^hppa/;
2118 #OLD: $target = '-old-asm' if $TargetPlatform =~ /^i386-/;
2119 #OLD: $target = '-m68k' if $TargetPlatform =~ /^m68k-/;
2120 #OLD: $target = '-mips' if $TargetPlatform =~ /^mips-/;
2121 #OLD: $target = '' if $TargetPlatform =~ /^powerpc-/;
2122 #OLD: $target = '-solaris' if $TargetPlatform =~ /^sparc-sun-solaris2/;
2123 #OLD: $target = '-sparc' if $TargetPlatform =~ /^sparc-sun-sunos4/;
2125 #OLD: if ( $target ne '' ) {
2126 #OLD: require("ghc-asm$target.prl")
2127 #OLD: || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm$target.prl!\n");
2128 #OLD: &mangle_asm($cc_as_o, "$cc_as-2"); # the OLD one!
2129 #OLD: &run_something("$Cmp -s $cc_as-2 $cc_as || $Diff $cc_as-2 $cc_as 1>&2 || exit 0",
2130 #OLD: "Diff'ing old and new mangled .s files"); # NB: to stderr
2133 } elsif ($TargetPlatform =~ /^hppa/) {
2134 # minor mangling of non-threaded files for hp-pa only
2135 require('ghc-asm.prl')
2136 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-hppa.prl!\n");
2137 &mini_mangle_asm_hppa($cc_as_o, $cc_as);
2139 } elsif ($TargetPlatform =~ /^i386/) {
2140 # extremely-minor OFFENSIVE mangling of non-threaded just one file
2141 require('ghc-asm.prl')
2142 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm.prl!\n");
2143 &mini_mangle_asm_i386($cc_as_o, $cc_as);
2146 # save a copy of the .s file, even if we are carrying on...
2147 if ($do_as && $Keep_s_file_too) {
2148 local($to_do) = "$Rm $ifile_root.s; $Cp $cc_as $ifile_root.s";
2149 &run_something($to_do, 'Saving copy of .s file');
2156 local($as_out, $ifile_root) = @_;
2158 local($asmblr) = ( $As ) ? $As : $CcRegd;
2160 if ( ! $SplitObjFiles ) {
2161 local($to_do) = "$asmblr -o $as_out -c @As_flags $cc_as";
2162 @Files_to_tidy = ( $as_out );
2163 &run_something($to_do, 'Unix assembler');
2165 } else { # more complicated split-ification...
2167 # must assemble files $Tmp_prefix__[1 .. $NoOfSplitFiles].s
2169 # If -odir is used, great, just pin it in front of the
2170 # generated split file names. If it hasn't been set, we
2171 # snatch it from the ifile_root.
2175 if ( $Specific_output_dir eq '' ) {
2176 $Specific_output_dir = ${ifile_root};
2179 for ($f = 1; $f <= $NoOfSplitFiles; $f++ ) {
2180 local($split_out) = &odir_ify("${ifile_root}__${f}",'o');
2181 local($to_do) = "$asmblr -o $split_out -c @As_flags ${Tmp_prefix}__${f}.s";
2182 @Files_to_tidy = ( $split_out );
2184 &run_something($to_do, 'Unix assembler');
2190 %************************************************************************
2192 \subsection[Driver-run-something]{@run_something@: Run a phase}
2194 %************************************************************************
2198 local($str_to_do, $tidy_name) = @_;
2200 print STDERR "\n$tidy_name:\n\t" if $Verbose;
2201 print STDERR "$str_to_do\n" if $Verbose;
2203 if ($Using_dump_file) {
2204 open(DUMP, ">> $Specific_dump_file")
2205 || &tidy_up_and_die(1,"$Pgm: failed to open `$Specific_dump_file'\n");
2206 print DUMP "\nCompilation Dump for: $str_to_do\n\n";
2208 || &tidy_up_and_die(1,"$Pgm: failed closing `$Specific_dump_file'\n");
2211 local($return_val) = 0;
2212 system("$Time $str_to_do");
2215 if ( $PostprocessCcOutput ) { # hack, continued
2216 open(CCOUT, "< $Tmp_prefix.ccout")
2217 || &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.ccout'\n");
2219 next if /attribute directive ignored/;
2220 next if /call-clobbered/;
2221 next if /from .*COptRegs\.lh/;
2222 next if /from .*(stg|rts)defs\.h:/;
2223 next if /from ghc\d+.c:\d+:/;
2224 next if /from .*\.lc/;
2225 next if /from .*SMinternal\.l?h/;
2226 next if /ANSI C does not support \`long long\'/;
2227 next if /warning:.*was declared \`extern\' and later \`static\'/;
2228 next if /warning: assignment discards \`const\' from pointer target type/;
2229 next if /: At top level:$/;
2230 next if /: In function \`.*\':$/;
2231 next if /\`ghc_cc_ID\' defined but not used/;
2234 close(CCOUT) || &tidy_up_and_die(1,"$Pgm: failed closing `$Tmp_prefix.ccout'\n");
2237 if ($return_val != 0) {
2238 if ($Using_dump_file) {
2239 print STDERR "Compilation Errors dumped in $Specific_dump_file\n";
2242 &tidy_up_and_die($return_val, '');
2244 $Using_dump_file = 0;
2248 %************************************************************************
2250 \subsection[Driver-ghctiming]{Emit nofibbish GHC timings}
2252 %************************************************************************
2254 NB: nearly the same as in @runstdtest@ script.
2257 sub process_ghc_timings {
2258 local($StatsFile) = "$Tmp_prefix.stat";
2259 local($SysSpecificTiming) = 'ghc';
2261 open(STATS, $StatsFile) || die "Failed when opening $StatsFile\n";
2262 local($tot_live) = 0; # for calculating avg residency
2265 $tot_live += $1 if /^\s*\d+\s+\d+\s+\d+\.\d+\%\s+(\d+)\s+\d+\.\d+\%/;
2267 $BytesAlloc = $1 if /^\s*([0-9,]+) bytes allocated in the heap/;
2269 if ( /^\s*([0-9,]+) bytes maximum residency .* (\d+) sample/ ) {
2270 $MaxResidency = $1; $ResidencySamples = $2;
2273 $GCs = $1 if /^\s*([0-9,]+) garbage collections? performed/;
2275 if ( /^\s*INIT\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2276 $InitTime = $1; $InitElapsed = $2;
2277 } elsif ( /^\s*MUT\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2278 $MutTime = $1; $MutElapsed = $2;
2279 } elsif ( /^\s*GC\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2280 $GcTime = $1; $GcElapsed = $2;
2283 close(STATS) || die "Failed when closing $StatsFile\n";
2284 if ( defined($ResidencySamples) && $ResidencySamples > 0 ) {
2285 $AvgResidency = int ($tot_live / $ResidencySamples) ;
2288 # warn about what we didn't find
2289 print STDERR "Warning: BytesAlloc not found in stats file\n" unless defined($BytesAlloc);
2290 print STDERR "Warning: GCs not found in stats file\n" unless defined($GCs);
2291 print STDERR "Warning: InitTime not found in stats file\n" unless defined($InitTime);
2292 print STDERR "Warning: InitElapsed not found in stats file\n" unless defined($InitElapsed);
2293 print STDERR "Warning: MutTime not found in stats file\n" unless defined($MutTime);
2294 print STDERR "Warning: MutElapsed not found in stats file\n" unless defined($MutElapsed);
2295 print STDERR "Warning: GcTime inot found in stats file\n" unless defined($GcTime);
2296 print STDERR "Warning: GcElapsed not found in stats file\n" unless defined($GcElapsed);
2298 # things we didn't necessarily expect to find
2299 $MaxResidency = 0 unless defined($MaxResidency);
2300 $AvgResidency = 0 unless defined($AvgResidency);
2301 $ResidencySamples = 0 unless defined($ResidencySamples);
2304 $BytesAlloc =~ s/,//g;
2305 $MaxResidency =~ s/,//g;
2307 $InitTime =~ s/,//g;
2308 $InitElapsed =~ s/,//g;
2310 $MutElapsed =~ s/,//g;
2312 $GcElapsed =~ s/,//g;
2314 # print out what we found
2315 print STDERR "<<$SysSpecificTiming: ",
2316 "$BytesAlloc bytes, $GCs GCs, $AvgResidency/$MaxResidency avg/max bytes residency ($ResidencySamples samples), $InitTime INIT ($InitElapsed elapsed), $MutTime MUT ($MutElapsed elapsed), $GcTime GC ($GcElapsed elapsed)",
2317 " :$SysSpecificTiming>>\n";
2324 %************************************************************************
2326 \subsection[Driver-dying]{@tidy_up@ and @tidy_up_and_die@: Dying gracefully}
2328 %************************************************************************
2332 local($to_do) = "\n$Rm $Tmp_prefix*";
2333 if ( $Tmp_prefix !~ /^\s*$/ ) {
2334 print STDERR "$to_do\n" if $Verbose;
2339 sub tidy_up_and_die {
2340 local($return_val, $msg) = @_;
2342 # delete any files to tidy
2343 print STDERR "deleting... @Files_to_tidy\n" if $Verbose && $#Files_to_tidy >= 0;
2344 unlink @Files_to_tidy if $#Files_to_tidy >= 0;
2348 exit (($return_val == 0) ? 0 : 1);
2352 %************************************************************************
2354 \subsection[Driver-arg-with-arg]{@grab_arg_arg@: Do an argument with an argument}
2356 %************************************************************************
2358 Some command-line arguments take an argument, e.g.,
2359 \tr{-Rmax-heapsize} expects a number to follow. This can either be
2360 given a part of the same argument (\tr{-Rmax-heapsize8M}) or as the
2361 next argument (\tr{-Rmax-heapsize 8M}). We allow both cases.
2363 Note: no error-checking; \tr{-Rmax-heapsize -Rgc-stats} will silently
2364 gobble the second argument (and probably set the heapsize to something
2368 local(*Args, $option, $rest_of_arg) = @_;
2371 return($rest_of_arg);
2372 } elsif ($#Args >= 0) {
2373 local($temp) = $Args[0]; shift(@Args);
2376 print STDERR "$Pgm: no argument following $option option\n";
2387 #Not in HsC_antiflag ## NO!: and not already in HsC_flags
2389 foreach $f ( @HsC_antiflags ) {
2390 return(0) if $flag eq $f;
2392 # foreach $f ( @HsC_flags ) {
2393 # return(0) if $flag eq $f;
2398 sub squashHscFlag { # pretty terrible
2402 foreach $f ( @HsC_flags ) {
2403 if ($flag eq $f) { $f = ''; }
2411 foreach $f ( @flags ) {
2412 push( @HsC_flags, $f ) if &isntAntiFlag($f);
2417 Source files may have {-# OPTIONS ... #-} pragmas at the top, containing
2418 command line options we want to append to collection of commands specified
2419 directly. @check_for_source_options@ looks at the top of a de-lit'ified Haskell
2420 file for any such pragmas:
2423 sub check_for_source_options {
2426 open(FILE,$file) || return(1); # No big loss
2429 if ( /^{-# OPTIONS (.*)#-}/ ) {
2430 # add the options found at the back of the command line.
2431 local(@entries) = split(/\s+/,$1);
2432 push(@File_options, @entries);
2434 elsif ( /^$/ ) { # ignore empty lines
2437 else { # stop looking, something non-empty / not
2438 # {-# OPTIONS .. #-} encountered.
2448 We split the initial argv up into three arrays:
2454 the reason for doing so is to be able to deal
2455 with {-# OPTIONS #-} pragma in source files properly.
2461 arg: while($_ = $args[0]) {
2463 # sigh, we have to deal with these -option arg specially here.
2464 /^-(tmpdir|odir|o|isuf|osuf|hisuf|hisuf-prelude|odump|syslib)$/ &&
2465 do { push(@Cmd_opts, $_); push(@Cmd_opts,$args[0]); shift(@args); next arg; };
2466 /^-./ && do { push(@Cmd_opts, $_); next arg; };
2469 push(@Link_file, $_);
2471 push(@Input_file, $_);
2474 # input files must exist:
2476 print STDERR "$Pgm: input file doesn't exist: $_\n";
2484 Command-line processor
2490 # can't use getopt(s); what we want is too complicated
2492 arg: while($_ = $Args[0]) {
2495 #---------- help -------------------------------------------------------
2496 if (/^-\?$/ || /^--?help$/) { print $LongUsage; exit $Status; }
2498 #-----------version ----------------------------------------------------
2499 /^--version$/ && do { print STDERR "${PROJECTNAME}, version ${PROJECTVERSION}, patchlevel ${PROJECTPATCHLEVEL}\n"; exit $Status; };
2501 #---------- verbosity and such -----------------------------------------
2502 /^-v$/ && do { $Verbose = '-v'; $Time = 'time'; next arg; };
2504 #---------- what phases are to be run ----------------------------------
2505 /^-recomp/ && do { $Do_recomp_chkr = 1; next arg; };
2507 /^-cpp$/ && do { $Cpp_flag_set = 1; next arg; };
2508 # change the global default:
2509 # we won't run cat; we'll run the real thing
2511 /^-C$/ && do { $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0; $HscOut = '-C=';
2513 # stop after generating C
2515 /^-noC$/ && do { $HscOut = '-N='; $ProduceHi = '-nohifile=';
2516 $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0;
2518 # leave out actual C generation (debugging) [also turns off interface gen]
2520 /^-hi$/ && do { $HiOnStdout = 1; $ProduceHi = '-hifile='; next arg; };
2521 # _do_ generate an interface; usually used as: -noC -hi
2523 /^-nohi$/ && do { $ProduceHi = '-nohifile='; next arg; };
2524 # don't generate an interface (even if generating C)
2526 /^-hi-diffs$/ && do { $HiDiff_flag = 'normal'; next arg; };
2527 /^-hi-diffs-with-usages$/ && do { $HiDiff_flag = 'usages'; next arg; };
2528 /^-no-hi-diffs$/ && do { $HiDiff_flag = ''; next arg; };
2529 # show/disable diffs if the interface file changes
2531 /^-E$/ && do { push(@CcBoth_flags, '-E');
2532 $Only_preprocess_C = 1;
2533 $Do_as = 0; $Do_lnkr = 0; next arg; };
2534 # stop after preprocessing C
2535 /^-M$/ && do { $Only_generate_deps = 1; $Do_as = 0; $Do_lnkr = 0; next arg; };
2536 # only generate dependency information.
2537 /^-S$/ && do { $Do_as = 0; $Do_lnkr = 0; next arg; };
2538 # stop after generating assembler
2540 /^-c$/ && do { $Do_lnkr = 0; next arg; };
2541 # stop after generating .o files
2543 /^-link-chk$/ && do { $LinkChk = 1; next arg; };
2544 /^-no-link-chk$/ && do { $LinkChk = 0; next arg; };
2545 # don't do consistency-checking after a link
2547 /^-tmpdir$/ && do { $Tmp_prefix = &grab_arg_arg(*Args,'-tmpdir', '');
2548 $Tmp_prefix = "$Tmp_prefix/ghc$$";
2549 $ENV{'TMPDIR'} = $Tmp_prefix; # for those who use it...
2551 # use an alternate directory for temp files
2553 #---------- redirect output --------------------------------------------
2555 # -o <file>; applies to the last phase, whatever it is
2556 # "-o -" sends it to stdout
2557 # if <file> has a directory component, that dir must already exist
2559 /^-odir$/ && do { $Specific_output_dir = &grab_arg_arg(*Args,'-odir', '');
2561 # Hack, of the worst sort: don't do validation of
2562 # odir argument if you're using -M (dependency generation).
2564 if ( ! $Only_generate_deps && ! -d $Specific_output_dir) {
2565 print STDERR "$Pgm: -odir: no such directory: $Specific_output_dir\n";
2570 /^-o$/ && do { $Specific_output_file = &grab_arg_arg(*Args,'-o', '');
2571 if ($Specific_output_file ne '-'
2572 && $Specific_output_file =~ /(.*)\/[^\/]*$/) {
2573 local($dir_part) = $1;
2574 if (! -d $dir_part) {
2575 print STDERR "$Pgm: no such directory: $dir_part\n";
2581 # NB: -isuf not documented yet (because it doesn't work yet)
2582 /^-isuf$/ && do { $Isuffix = &grab_arg_arg(*Args,'-isuf', '');
2583 if ($Isuffix =~ /\./ ) {
2584 print STDERR "$Pgm: -isuf suffix shouldn't contain a .\n";
2589 /^-osuf$/ && do { $Osuffix = &grab_arg_arg(*Args,'-osuf', '');
2590 if ($Osuffix =~ /\./ ) {
2591 print STDERR "$Pgm: -osuf suffix shouldn't contain a .\n";
2596 # -ohi <file>; send the interface to <file>; "-ohi -" to send to stdout
2597 /^-ohi$/ && do { $Specific_hi_file = &grab_arg_arg(*Args,'-ohi', '');
2598 if ($Specific_hi_file ne '-'
2599 && $Specific_hi_file =~ /(.*)\/[^\/]*$/) {
2600 local($dir_part) = $1;
2601 if (! -d $dir_part) {
2602 print STDERR "$Pgm: no such directory: $dir_part\n";
2608 # The suffix to use when looking for interface files
2609 /^-hisuf$/ && do { $HiSuffix = &grab_arg_arg(*Args,'-hisuf', '');
2610 if ($HiSuffix =~ /\./ ) {
2611 print STDERR "$Pgm: -hisuf suffix shouldn't contain a .\n";
2615 # ToDo: remove, not a `normal' user thing to do (should be automatic)
2616 /^-hisuf-prelude$/ && do { $HiSuffix_prelude = &grab_arg_arg(*Args,'-hisuf-prelude', '');
2617 if ($HiSuffix =~ /\./ ) {
2618 print STDERR "$Pgm: -hisuf-prelude suffix shouldn't contain a .\n";
2622 /^-odump$/ && do { $Specific_dump_file = &grab_arg_arg(*Args,'-odump', '');
2623 if ($Specific_dump_file =~ /(.*)\/[^\/]*$/) {
2624 local($dir_part) = $1;
2625 if (! -d $dir_part) {
2626 print STDERR "$Pgm: no such directory: $dir_part\n";
2632 #-------------- scc & Profiling Stuff ----------------------------------
2634 /^-prof$/ && do { $PROFing = 'p'; next arg; }; # profiling -- details later!
2637 # generate auto SCCs on top level bindings
2638 # -auto-all = all top level bindings
2639 # -auto = only top level exported bindings
2640 $PROFauto = ( /-all/ )
2641 ? '-fauto-sccs-on-all-toplevs'
2642 : '-fauto-sccs-on-exported-toplevs';
2645 /^-caf-all/ && do { # generate individual CAF SCC annotations
2646 $PROFcaf = '-fauto-sccs-on-individual-cafs';
2649 /^-ignore-scc$/ && do {
2650 # forces ignore of scc annotations even if profiling
2651 $PROFignore_scc = '-W';
2654 /^-G(.*)$/ && do { push(@HsC_flags, "-G=$1"); # set group for cost centres
2657 /^-unprof-scc-auto/ && do {
2658 # generate auto SCCs on top level bindings when not profiling.
2659 # Used to measure optimisation effects of presence of sccs.
2660 $UNPROFscc_auto = ( /-all/ )
2661 ? '-fauto-sccs-on-all-toplevs'
2662 : '-fauto-sccs-on-exported-toplevs';
2665 #--------- ticky/concurrent/parallel -----------------------------------
2666 # we sort out the details a bit later on
2668 /^-concurrent$/ && do { $CONCURing = 'c'; next arg; }; # concurrent Haskell
2669 /^-gransim$/ && do { $GRANing = 'g'; next arg; }; # GranSim
2670 /^-ticky$/ && do { $TICKYing = 't'; next arg; }; # ticky-ticky
2671 /^-parallel$/ && do { $PARing = 'p'; next arg; }; # parallel Haskell
2673 #-------------- "user ways" --------------------------------------------
2675 (/^-user-setup-([a-oA-Z])$/ ) &&
2677 /^-user-setup-([a-oA-Z])$/ && do { $BuildTag = "_$1"; };
2679 local($stuff) = $UserSetupOpts{$BuildTag};
2680 local(@opts) = split(/\s+/, $stuff);
2682 # feed relevant ops into the arg-processing loop (if any)
2683 unshift(@Args, @opts) if $#opts >= 0;
2687 #---------- set search paths for libraries and things ------------------
2689 # we do -i just like HBC (-i clears the list; -i<colon-separated-items>
2690 # prepends the items to the list); -I is for including C .h files.
2692 /^-i$/ && do { @Import_dir = (); # import path cleared!
2693 @SysImport_dir = ();
2694 print STDERR "WARNING: import paths cleared by `-i'\n";
2697 /^-i(.*)/ && do { local(@new_items)
2698 = split( /:/, &grab_arg_arg(*Args,'-i', $1));
2699 unshift(@Import_dir, @new_items);
2702 /^-I(.*)/ && do { push(@Include_dir, &grab_arg_arg(*Args,'-I', $1)); next arg; };
2703 /^-L(.*)/ && do { push(@UserLibrary_dir, &grab_arg_arg(*Args,'-L', $1)); next arg; };
2704 /^-l(.*)/ && do { push(@UserLibrary,'-l'.&grab_arg_arg(*Args,'-l', $1)); next arg; };
2706 /^-syslib(.*)/ && do { local($syslib) = &grab_arg_arg(*Args,'-syslib',$1);
2707 print STDERR "$Pgm: no such system library (-syslib): $syslib\n",
2708 $Status++ unless $syslib =~ /^(hbc|ghc|posix|contrib)$/;
2710 unshift(@SysImport_dir,
2712 ? "$InstSysLibDir/$syslib/imports"
2713 : "$TopPwd/hslibs/$syslib/src");
2715 if ( ${INSTALLING} ) {
2716 push(@SysLibrary_dir,
2717 ("$InstSysLibDir"));
2719 push(@SysLibrary_dir,
2720 ("$TopPwd/hslibs/$syslib"
2721 ,"$TopPwd/hslibs/$syslib/cbits"));
2724 push(@SysLibrary, "-lHS$syslib");
2725 push(@SysLibrary, "-lHS${syslib}_cbits")
2726 unless $syslib eq 'contrib'; #HACK! it has no cbits
2730 #=======================================================================
2731 # various flags that we can harmlessly send to one program or another
2732 # (we will later "reclaim" some of the compiler ones now sent to gcc)
2733 #=======================================================================
2735 #---------- this driver itself (ghc) -----------------------------------
2736 # these change what executable is run for each phase:
2737 /^-pgmL(.*)$/ && do { $Unlit = $1; next arg; };
2738 /^-pgmP(.*)$/ && do { $HsCpp = $1; next arg; };
2739 /^-pgmC(.*)$/ && do { $HsC = $1; next arg; };
2740 /^-pgmcO?(.*)$/ && do { $CcRegd = $1; next arg; }; # the O? for back compat
2741 /^-pgma(.*)$/ && do { $As = $1; next arg; };
2742 /^-pgml(.*)$/ && do { $Lnkr = $1; next arg; };
2743 /^-pgmdep(.*)$/ && do { $MkDependHS = $1; next arg; };
2745 #---------- the get-anything-through opts (all pgms) -------------------
2746 # these allow arbitrary option-strings to go to any phase:
2747 /^-optL(.*)$/ && do { push(@Unlit_flags, $1); next arg; };
2748 /^-optP(.*)$/ && do { push(@HsCpp_flags, $1); next arg; };
2749 /^-optCrts(.*)$/&& do { push(@HsC_rts_flags, $1); next arg; };
2750 /^-optC(.*)$/ && do { push(@HsC_flags, $1); next arg; };
2751 /^-optcpp(.*)$/ && do { push(@Cpp_define, $1); next arg; };
2752 /^-optc(.*)$/ && do { push(@CcBoth_flags, $1); next arg; };
2753 /^-opta(.*)$/ && do { push(@As_flags, $1); next arg; };
2754 /^-optl(.*)$/ && do { push(@Ld_flags, $1); next arg; };
2755 /^-optdep(.*)$/ && do { push(@MkDependHS_flags, $1); next arg; };
2757 #---------- Haskell C pre-processor (hscpp) ----------------------------
2758 /^-D(.*)/ && do { push(@HsCpp_flags, "'-D".&grab_arg_arg(*Args,'-D',$1)."'"); next arg; };
2759 /^-U(.*)/ && do { push(@HsCpp_flags, "'-U".&grab_arg_arg(*Args,'-U',$1)."'"); next arg; };
2761 /^-genSPECS/ && do { $Cpp_flag_set = 1;
2762 $genSPECS_flag = $_;
2765 #---------- post-Haskell "assembler"------------------------------------
2766 /^-ddump-raw-asm$/ && do { $Dump_raw_asm = 1; next arg; };
2767 /^-ddump-asm-splitting-info$/ && do { $Dump_asm_splitting_info = 1; next arg; };
2769 #---------- Haskell compiler (hsc) -------------------------------------
2771 /^-keep-hc-files?-too$/ && do { $Keep_hc_file_too = 1; next arg; };
2772 /^-keep-s-files?-too$/ && do { $Keep_s_file_too = 1; next arg; };
2774 /^-fhaskell-1\.3$/ && do { next arg; }; # a no-op right now
2776 /^-fignore-interface-pragmas$/ && do { push(@HsC_flags, $_); next arg; };
2778 /^-fno-implicit-prelude$/ && do { $NoImplicitPrelude= 1; push(@HsC_flags, $_); next arg; };
2779 # don't do stack checking using page fault `trick'.
2781 /^-fstack-check$/ && do { $StkChkByPageFaultOK = 0; next arg; };
2783 # have the compiler proper generate concurrent code,
2784 # really only used when you want to configure your own
2785 # special user compilation way. (Use -concurrent when
2786 # compiling `Concurrent Haskell' programs).
2788 # (ditto for -fgransim, fscc-profiling and -fticky-ticky)
2790 /^-fconcurrent$/ && do { push(@HsC_flags,$_); next arg; };
2791 /^-fscc-profiling$/ && do { push(@HsC_flags,$_); next arg; };
2792 /^-fticky-ticky$/ && do { push(@HsC_flags,$_); next arg; };
2793 /^-fgransim$/ && do { push(@HsC_flags,$_); next arg; };
2795 /^-user-prelude-force/ && do { # ignore if not -user-prelude
2798 /^-split-objs/ && do {
2799 if ( $TargetPlatform !~ /^(alpha|hppa1\.1|i386|m68k|mips|powerpc|sparc)-/ ) {
2801 print STDERR "WARNING: don't know how to split objects on this platform: $TargetPlatform\n`-split-objs' option ignored\n";
2806 push(@HsC_flags, "-fglobalise-toplev-names");
2807 push(@CcBoth_flags, '-DUSE_SPLIT_MARKERS');
2809 require('ghc-split.prl')
2810 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-split.prl!\n");
2815 && do { push(@HsC_flags, $_);
2816 push(@HsP_flags, '-N');
2818 # push(@HsC_flags, '-fshow-import-specs');
2822 /^-fspeciali[sz]e-unboxed$/
2823 && do { $Oopt_DoSpecialise = '-fspecialise';
2824 $Oopt_SpecialiseUnboxed = '-fspecialise-unboxed';
2827 && do { $Oopt_DoSpecialise = '-fspecialise'; next arg; };
2828 /^-fno-speciali[sz]e$/
2829 && do { $Oopt_DoSpecialise = ''; next arg; };
2832 # Now the foldr/build options, which are *on* by default (for -O).
2835 && do { $Oopt_FoldrBuild = 1;
2836 $Oopt_FB_Support = '-fdo-arity-expand';
2840 /^-fno-foldr-build$/
2841 && do { $Oopt_FoldrBuild = 0;
2842 $Oopt_FB_Support = '';
2845 /^-fno-foldr-build-rule$/
2846 && do { $Oopt_FoldrBuild = 0;
2849 /^-fno-enable-tech$/
2850 && do { $Oopt_FB_Support = '';
2853 /^-fno-snapback-to-append$/
2854 && do { $Oopt_FoldrBuildInline .= ' -fdo-not-fold-back-append ';
2859 /^-fasm-(.*)$/ && do { $HscOut = '-S='; next arg; }; # force using nativeGen
2860 /^-fvia-C$/ && do { $HscOut = '-C='; next arg; }; # force using C compiler
2864 /^(-funfolding-use-threshold)(.*)$/
2865 && do { $Oopt_UnfoldingUseThreshold = $1 . &grab_arg_arg(*Args,$1, $2);
2868 /^(-fmax-simplifier-iterations)(.*)$/
2869 && do { $Oopt_MaxSimplifierIterations = $1 . &grab_arg_arg(*Args,$1, $2);
2872 /^-fno-pedantic-bottoms$/
2873 && do { $Oopt_PedanticBottoms = ''; next arg; };
2875 /^-fdo-monad-eta-expansion$/
2876 && do { $Oopt_MonadEtaExpansion = $_; next arg; };
2878 /^-fno-let-from-(case|app|strict-let)$/ # experimental, really (WDP 95/10)
2879 && do { push(@HsC_flags, $_); next arg; };
2881 /^(-freturn-in-regs-threshold)(.*)$/
2882 && do { local($what) = $1;
2883 local($num) = &grab_arg_arg(*Args,$what, $2);
2884 if ($num < 2 || $num > 8) {
2885 die "Bad experimental flag: $_\n";
2887 $HscOut = '-C='; # force using C compiler
2888 push(@HsC_flags, "$what$num");
2889 push(@CcRegd_flags, "-D__STG_REGS_AVAIL__=$num");
2893 # --------------- Warnings etc. ------
2895 /^-f(show-import-specs)/
2896 && do { push(@HsC_flags, $_); next arg; };
2898 # for now, just -fwarn-name-shadowing
2899 /^-fwarn-(.*)$/ && do { push(@HsC_flags, $_); next arg; };
2900 /^-fno-(.*)$/ && do { push(@HsC_antiflags, "-f$1");
2901 &squashHscFlag("-f$1");
2904 # --------------- platform specific flags (for gcc mostly) ----------------
2906 /^-mlong-calls$/ && do { # for GCC for HP-PA boxes,
2907 # for 2.6.x..?, does not apply for 2.7.2
2909 unshift(@CcBoth_flags, ( $_ ));
2912 /^-m(v8|sparclite|cypress|supersparc|cpu=(cypress|supersparc))$/
2913 && do { # for GCC for SPARCs
2914 unshift(@CcBoth_flags, ( $_ ));
2917 /^-monly-([432])-regs/ && do { # for iX86 boxes only; no effect otherwise
2918 $StolenX86Regs = $1;
2921 #*************** ... and lots of debugging ones (form: -d* )
2923 # -d(no-)core-lint is done this way so it is turn-off-able.
2924 /^-dcore-lint/ && do { $CoreLint = '-dcore-lint'; next arg; };
2925 /^-dno-core-lint/ && do { $CoreLint = ''; next arg; };
2926 # Ditto for STG lint
2927 /^-dstg-lint/ && do { $StgLint = '-dstg-lint'; next arg; };
2928 /^-dno-stg-lint/ && do { $StgLint = ''; next arg; };
2930 /^-d(dump|ppr)-/ && do { push(@HsC_flags, $_); next arg; };
2931 /^-dverbose-(simpl|stg)/ && do { push(@HsC_flags, $_); next arg; };
2932 /^-dshow-passes/ && do { push(@HsC_flags, $_); next arg; };
2933 /^-dshow-rn-trace/ && do { push(@HsC_flags, $_); next arg; };
2934 /^-dsource-stats/ && do { push(@HsC_flags, $_); next arg; };
2935 /^-dsimplifier-stats/ && do { push(@HsC_flags, $_); next arg; };
2936 /^-dstg-stats/ && do { $Oopt_StgStats = $_; next arg; };
2938 #*************** ... and now all these -R* ones for its runtime system...
2940 /^-Rscale-sizes?(.*)/ && do {
2941 $Scale_sizes_by = &grab_arg_arg(*Args,'-Rscale-sizes', $1);
2944 /^(-H|-Rmax-heapsize)(.*)/ && do {
2945 local($heap_size) = &grab_arg_arg(*Args,$1, $2);
2946 if ($heap_size =~ /(\d+)[Kk]$/) {
2947 $heap_size = $1 * 1000;
2948 } elsif ($heap_size =~ /(\d+)[Mm]$/) {
2949 $heap_size = $1 * 1000 * 1000;
2950 } elsif ($heap_size =~ /(\d+)[Gg]$/) {
2951 $heap_size = $1 * 1000 * 1000 * 1000;
2953 if ($heap_size <= 0) {
2954 print STDERR "$Pgm: resetting heap-size to zero!!! $heap_size\n";
2955 $Specific_heap_size = 0;
2957 # if several heap sizes given, take the largest...
2958 } elsif ($heap_size >= $Specific_heap_size) {
2959 $Specific_heap_size = $heap_size;
2961 print STDERR "$Pgm: ignoring heap-size-setting option ($_)...not the largest seen\n";
2965 /^-(K|Rmax-(stk|stack)size)(.*)/ && do {
2967 local($stk_size) = &grab_arg_arg(*Args,'-Rmax-stksize', $3);
2968 if ($stk_size =~ /(\d+)[Kk]$/) {
2969 $stk_size = $1 * 1000;
2970 } elsif ($stk_size =~ /(\d+)[Mm]$/) {
2971 $stk_size = $1 * 1000 * 1000;
2972 } elsif ($stk_size =~ /(\d+)[Gg]$/) {
2973 $stk_size = $1 * 1000 * 1000 * 1000;
2975 if ($stk_size <= 0) {
2976 print STDERR "$Pgm: resetting stack-size to zero!!! $stk_size\n";
2977 $Specific_stk_size = 0;
2979 # if several stack sizes given, take the largest...
2980 } elsif ($stk_size >= $Specific_stk_size) {
2981 $Specific_stk_size = $stk_size;
2983 print STDERR "$Pgm: ignoring stack-size-setting option ($flag $stk_size)...not the largest seen\n";
2987 /^-Rgc-stats$/ && do { $CollectingGCstats++;
2988 # the two RTSs do this diff ways; we will try to compensate
2991 /^-Rghc-timing/ && do { $CollectGhcTimings = 1; next arg; };
2993 #---------- C high-level assembler (gcc) -------------------------------
2994 /^-(Wall|ansi|pedantic)$/ && do { push(@CcBoth_flags, $_); next arg; };
2996 # -dgcc-lint is a useful way of making GCC very fussy.
2997 # From alan@spri.levels.unisa.edu.au (Alan Modra).
2998 /^-dgcc-lint$/ && do { push(@CcBoth_flags, '-Wall -Wpointer-arith -Wbad-function-cast -Wcast-qual -Wstrict-prototypes -Wmissing-prototypes -Wmissing-declarations -Wnested-externs'); next arg; };
2999 # An alternate set, from mark@sgcs.com (Mark W. Snitily)
3000 # -Wall -Wstrict-prototypes -Wmissing-prototypes -Wcast-align -Wshadow
3002 # inject "#include <wurble>" into the compiler's C output!
3004 /^-#include(.*)/ && do {
3005 local($to_include) = &grab_arg_arg(*Args,'-#include', $1);
3006 push(@CcInjects, "#include $to_include\n");
3009 #---------- Linker (gcc, really) ---------------------------------------
3011 /^-static$/ && do { push(@Ld_flags, $_); next arg; };
3013 #---------- mixed cc and linker magic ----------------------------------
3014 # this optimisation stuff is finally sorted out later on...
3016 /^-O2-for-C$/ && do { $MinusO2ForC = 1; next arg; };
3018 /^-O[1-2]?$/ && do {
3019 local($opt_lev) = ( /^-O2$/ ) ? 2 : 1; # max 'em
3020 $OptLevel = ( $opt_lev > $OptLevel ) ? $opt_lev : $OptLevel;
3022 $HscOut = '-C=' if $OptLevel == 2; # force use of C compiler
3025 /^-Onot$/ && do { $OptLevel = 0; next arg; }; # # set it to <no opt>
3027 /^-Ofile(.*)/ && do {
3029 local($ofile) = &grab_arg_arg(*Args,'-Ofile', $1);
3030 @HsC_minusO3_flags = ();
3032 open(OFILE, "< $ofile") || die "Can't open $ofile!\n";
3035 s/\#.*//; # death to comments
3036 s/[ \t]+//g; # death to whitespace
3037 next if /^$/; # ditto, blank lines
3038 s/([()*{}])/\\$1/g; # protect shell metacharacters
3040 push(@CcBoth_flags, $1);
3042 push(@HsC_minusO3_flags, $_);
3048 /^-debug$/ && do { # all this does is mark a .hc/.o as "debugging"
3049 # in the consistency info
3053 #---------- linking .a file --------------------------------------------
3055 /^-Main(.*)/ && do {
3056 # specifies main or mainPrimIO to be linked
3060 #---------- catch unrecognized flags -----------------------------------
3063 print STDERR "$Pgm: unrecognised option: $_\n";
3069 } # end of processArgs