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 libexecdir 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}";
136 # Normally the same as InstLibDirGhc, but we accommodate
137 # for it being separate.
139 $InstLibExecDirGhc = "${libexecdir}";
140 $InstDataDirGhc = "${datadir}";
141 $InstSysLibDir = ( $INSTALLING ) ? "${InstLibDirGhc}/hslibs" : "$TopPwd/hslibs";
143 $Status = 0; # just used for exit() status
146 # set up signal handler
147 sub quit_upon_signal { &tidy_up_and_die(1, ''); }
148 $SIG{'INT'} = 'quit_upon_signal';
149 $SIG{'QUIT'} = 'quit_upon_signal';
151 # where to get "require"d .prl files at runtime (poor man's dynamic loading)
152 # (use LIB, not DATA, because we can't be sure of arch-independence)
153 @INC = ( ( $INSTALLING ) ? $InstLibDirGhc
154 : "$TopPwd/${CURRENT_DIR}" );
156 if ( $ENV{'TMPDIR'} ) { # where to make tmp file names
157 $Tmp_prefix = ($ENV{'TMPDIR'} . "/ghc$$");
159 print STDERR "TMPDIR has not been set to anything useful!\n" if (${TMPDIR} eq '');
160 $Tmp_prefix ="${TMPDIR}/ghc$$"; # TMPDIR set via Makefile when booting..
161 $ENV{'TMPDIR'} = ${TMPDIR}; # set the env var as well
164 # Some shells run into real trouble when command line and environment
165 # gets big (e.g., cmd lines of >4K to /bin/sh causes havoc on our
166 # Solaris-2.5.1 boxes - even though sysconf(_SC_ARG_MAX) reports 1M ...).
167 # To work around any such */bin/sh* problems, we will scribble such
168 # awfully long command lines into a temp file and exec that temp file
169 # with $(REAL_SHELL) (don't use the SHELL variable directly as this
170 # will normally get you the wrong thing when the driver is invoked
171 # from within `make'). If the REAL_SHELL variable isn't set, you'll
172 # get SHELL. This is all a terrible hack. (in case you hadn't reached
173 # the same conclusion by now :-)
177 if ( ! $ENV{'REAL_SHELL'} ) {
178 $ENV{'REAL_SHELL'} = $ENV{'SHELL'};
181 @Files_to_tidy = (); # files we nuke in the case of abnormal termination
183 $Unlit = ( $INSTALLING ) ? "$InstLibExecDirGhc/unlit"
184 : "$TopPwd/${CURRENT_DIR}/${GHC_UNLIT}";
188 $Diff = $CONTEXT_DIFF;
193 $HsCpp = # but this is re-set to "cat" (after options) if -cpp not seen
194 ( $INSTALLING ) ? "$InstLibexecDirGhc/hscpp"
195 : "$TopPwd/${CURRENT_DIR}/${GHC_HSCPP}";
198 $genSPECS_flag = ''; # See ../utils/hscpp/hscpp.prl
199 $HsC = ( $INSTALLING ) ? "$InstLibExecDirGhc/hsc"
200 : "$TopPwd/${CURRENT_DIR}/${GHC_HSC}";
202 # For PVM fiends only
203 $SysMan = ( $INSTALLING ) ? "$InstLibExecDirGhc/SysMan"
204 : "$TopPwd/${CURRENT_DIR}/${GHC_SYSMAN}";
209 # HsC_rts_flags: if we want to talk to the LML runtime system
210 # NB: we don't use powers-of-2 sizes, because this may do
211 # terrible things to cache behavior.
213 $Specific_heap_size = 6 * 1000 * 1000;
214 $Specific_stk_size = 1000 * 1000;
215 $Scale_sizes_by = 1.0;
219 The variables set by @setupOptFlags@ represent parts of the
220 -O/-O2/etc ``templates,'' which are filled in later, using these.
221 These are the default values, which may be changed by user flags.
225 $Oopt_UnfoldingUseThreshold = '-fsimpl-uf-use-threshold3';
226 $Oopt_MaxSimplifierIterations = '-fmax-simplifier-iterations4';
227 $Oopt_PedanticBottoms = '-fpedantic-bottoms'; # ON by default
228 $Oopt_MonadEtaExpansion = '';
229 $Oopt_FinalStgProfilingMassage = '';
231 $Oopt_SpecialiseUnboxed = '';
232 $Oopt_DoSpecialise = ''; # ToDo:LATER: '-fspecialise';
233 $Oopt_FoldrBuild = 0; # *Off* by default!
234 $Oopt_FB_Support = ''; # was '-fdo-arity-expand';
235 # $Oopt_FoldrBuildWW = 0; # Off by default
236 $Oopt_FoldrBuildInline = ''; # was '-fdo-inline-foldr-build';
237 } # end of setupOptFlags
239 # Assign defaults to these right away.
243 Things to do with C compilers/etc:
245 $CcRegd = $GHC_OPT_HILEV_ASM;
246 @CcBoth_flags = ('-S'); # flags for *any* C compilation
250 # those for all files,
251 # those only for .c files;
252 # those only for .hc files
254 @CcRegd_flags = ('-ansi', '-D__STG_GCC_REGS__', '-D__STG_TAILJUMPS__');
255 @CcRegd_flags_c = ();
256 @CcRegd_flags_hc = ();
258 $As = ''; # "assembler" is normally GCC
261 $Lnkr = ''; # "linker" is normally GCC
264 # 'nm' is used for consistency checking (ToDo: mk-world-ify)
265 # ToDo: check the OS or something ("alpha" is surely not the crucial question)
266 $Nm = ($TargetPlatform =~ /^alpha-/) ? 'nm -B' : 'nm';
269 What options \tr{-user-setup-a} turn into (user-defined ``packages''
270 of options). Note that a particular user-setup implies a particular
271 Prelude ({\em including} its interface file(s)).
273 $BuildTag = ''; # default is sequential build w/ Appel-style GC
275 %BuildDescr = (# system ways begin
276 '', 'normal sequential',
280 '_mc', "$WAY_mc_NAME",
281 '_mr', "$WAY_mr_NAME",
282 '_mt', "$WAY_mt_NAME",
283 '_mp', "$WAY_mp_NAME",
284 '_mg', "$WAY_mg_NAME",
285 '_2s', "$WAY_2s_NAME",
286 '_1s', "$WAY_1s_NAME",
287 '_du', "$WAY_du_NAME",
305 '_B', "$WAY_B_NAME" );
307 # these are options that are "fed back" through the option processing loop
311 '_a', "$WAY_a_HC_OPTS",
312 '_b', "$WAY_b_HC_OPTS",
313 '_c', "$WAY_c_HC_OPTS",
314 '_d', "$WAY_d_HC_OPTS",
315 '_e', "$WAY_e_HC_OPTS",
316 '_f', "$WAY_f_HC_OPTS",
317 '_g', "$WAY_g_HC_OPTS",
318 '_h', "$WAY_h_HC_OPTS",
319 '_i', "$WAY_i_HC_OPTS",
320 '_j', "$WAY_j_HC_OPTS",
321 '_k', "$WAY_k_HC_OPTS",
322 '_l', "$WAY_l_HC_OPTS",
323 '_m', "$WAY_m_HC_OPTS",
324 '_n', "$WAY_n_HC_OPTS",
325 '_o', "$WAY_o_HC_OPTS",
326 '_A', "$WAY_A_HC_OPTS",
327 '_B', "$WAY_B_HC_OPTS",
330 '_p', "$WAY_p_HC_OPTS",
331 '_t', "$WAY_t_HC_OPTS",
332 '_u', "$WAY_u_HC_OPTS",
333 '_mc', "$WAY_mc_HC_OPTS",
334 '_mr', "$WAY_mr_HC_OPTS",
335 '_mt', "$WAY_mt_HC_OPTS",
336 '_mp', "$WAY_mp_HC_OPTS",
337 '_mg', "$WAY_mg_HC_OPTS",
338 '_2s', "$WAY_2s_HC_OPTS",
339 '_1s', "$WAY_1s_HC_OPTS",
340 '_du', "$WAY_B_HC_OPTS" );
342 # per-build code fragments which are eval'd
343 #%EvaldSetupOpts = ('', '', # this one must *not* be set!
345 # # profiled sequential
346 # '_p', 'push(@HsC_flags, \'-fscc-profiling\');
347 # push(@CcBoth_flags, \'-DPROFILING\');',
350 # #push(@CcBoth_flags, '-DPROFILING_DETAIL_COUNTS');
352 # # ticky-ticky sequential
353 # '_t', 'push(@HsC_flags, \'-fticky-ticky\');
354 # push(@CcBoth_flags, \'-DTICKY_TICKY\');',
356 ##OLD: # unregisterized (ToDo????)
360 # '_mc', '$StkChkByPageFaultOK = 0;
361 # push(@HsC_flags, \'-fconcurrent\');
362 # push(@HsCpp_flags,\'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\');
363 # push(@Cpp_define, \'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\');',
365 # # profiled concurrent
366 # '_mr', '$StkChkByPageFaultOK = 0;
367 # push(@HsC_flags, \'-fconcurrent\', \'-fscc-profiling\');
368 # push(@HsCpp_flags,\'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\');
369 # push(@Cpp_define, \'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\', \'-DPROFILING\');',
371 # # ticky-ticky concurrent
372 # '_mt', '$StkChkByPageFaultOK = 0;
373 # push(@HsC_flags, \'-fconcurrent\', \'-fticky-ticky\');
374 # push(@HsCpp_flags,\'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\');
375 # push(@Cpp_define, \'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\', \'-DTICKY_TICKY\');',
378 # '_mp', '$StkChkByPageFaultOK = 0;
379 # push(@HsC_flags, \'-fconcurrent\');
380 # push(@HsCpp_flags,\'-D__PARALLEL_HASKELL__\', \'-DPAR\');
381 # push(@Cpp_define, \'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\', \'-DPAR\');',
384 # '_mg', '$StkChkByPageFaultOK = 0;
385 # push(@HsC_flags, \'-fconcurrent\', \'-fgransim\');
386 # push(@HsCpp_flags,\'-D__GRANSIM__\', \'-DGRAN\');
387 # push(@Cpp_define, \'-D__CONCURRENT_HASKELL__\', \'-DCONCURRENT\', \'-DGRAN\');',
389 # '_2s', 'push (@CcBoth_flags, \'-DGC2s\');',
390 # '_1s', 'push (@CcBoth_flags, \'-DGC1s\');',
391 # '_du', 'push (@CcBoth_flags, \'-DGCdu\');',
393 # '_a', '', # these user-way guys should not be set!
413 Import/include directories (\tr{-I} options) are sufficiently weird to
414 require special handling.
417 @Import_dir = ('.'); #-i things
418 @Include_dir = ('.'); #-I things; other default(s) stuck on AFTER option processing
420 # where to look for interface files (system hi's, i.e., prelude and hslibs)
421 @SysImport_dir = ( $INSTALLING )
422 ? ( "$InstLibDirGhc/imports" )
423 : ( "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/required"
424 , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/ghc"
425 , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/glaExts"
426 , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/concurrent" );
428 # We need to look in ghc/ and glaExts/ when searching for implicitly needed .hi files, but
429 # we should really *not* look there for explicitly imported modules.
431 $GhcVersionInfo = int ($PROJECTVERSION * 100);
432 $Haskell1Version = 4; # i.e., Haskell 1.4
435 @UserLibrary_dir= (); #-L things;...
436 @UserLibrary = (); #-l things asked for by the user
438 @SysLibrary_dir = ( ( $INSTALLING ) #-syslib things supplied by the system
440 : ( "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR"
441 , "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR/gmp"
442 , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR"
443 , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/cbits"
446 @SysLibrary = (); # will be built up as we go along
448 $TopClosureFile # defaults to 1.2 one; will be mangled later
449 = ( $INSTALLING) ? "$InstLibDirGhc/TopClosureXXXX.o"
450 : "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR/main/TopClosureXXXX.o";
452 # make depend for Haskell
454 = ( $INSTALLING ) ? "$InstBinDirGhc/mkdependHS"
455 : "$TopPwd/$CURRENT_DIR/$GHC_UTILS_DIR/mkdependHS/mkdependHS";
457 @MkDependHS_flags = ( );
459 # do_link flag should not be reset while rescanning the cmd-line.
461 $Specific_output_dir = ''; # set by -odir <dir>
462 $Specific_output_file = ''; # set by -o <file>; "-" for stdout
465 Function to initialise the per-compilation-unit globals that
466 are used to guide and control the invocation of the different phases.
469 sub initDriverGlobals {
471 # reset the following options:
472 # RTS flags to use while compiling
474 @HsP_flags = (); # these are the flags destined solely for
475 # the flex/yacc parser
480 The optimisations/etc to be done by the compiler are {\em normally}
481 expressed with a \tr{-O} (or \tr{-O2}) flag, or by its absence.
484 $OptLevel = 0; # no -O == 0; -O == 1; -O2 == 2; -Ofile == 3
485 $MinusO2ForC = 0; # set to 1 if -O2 should be given to C compiler
486 $StolenX86Regs = 4; # **HACK*** of the very worst sort
490 @CcBoth_flags = ('-S'); # flags for *any* C compilation
493 # GCC flags: those for all files, those only for .c files; those only for .hc files
494 @CcRegd_flags = ('-ansi', '-D__STG_GCC_REGS__', '-D__STG_TAILJUMPS__');
495 @CcRegd_flags_c = ();
496 @CcRegd_flags_hc = ();
498 @Import_dir = ('.'); #-i things
499 @Include_dir = ('.'); #-I things; other default(s) stuck on AFTER option processing
504 We are given a list of files with various presumably-known suffixes
505 (unknown-suffix files go straight to the linker). For each file, we
506 begin by assuming that we'll run every phase over it. However: (1)
507 global flags (\tr{-c}, \tr{-S}, etc.) tell us not to run any phase
508 past a certain point; and (2) the file's suffix tells us what phase to
509 start with. Linking is weird and kept track of separately.
511 Here are the initial defaults applied to all files:
513 $Cpp_flag_set = 0; # (hack)
514 $Only_preprocess_C = 0; # pretty hackish
515 $Only_generate_deps = 0; #
516 $PostprocessCcOutput = 0;
518 # native code-gen or via C?
519 $HaveNativeCodeGen = $GhcWithNativeCodeGen;
520 $HscOut = '-C='; # '-C=' ==> .hc output; '-S=' ==> .s output; '-N=' ==> neither
522 if $HaveNativeCodeGen && $TargetPlatform =~ /^(alpha|sparc)-/;
523 # TEMP: disable x86 if $HaveNativeCodeGen && $TargetPlatform =~ /^(i386|alpha|sparc)-/;
524 $ProduceHi = '-hifile=';
528 $CollectingGCstats = 0;
529 $CollectGhcTimings = 0;
530 $DEBUGging = ''; # -DDEBUG and all that it entails (um... not really)
531 $PROFing = ''; # set to p or e if profiling
532 $PROFgroup = ''; # set to group if an explicit -Ggroup specified
533 $PROFauto = ''; # set to relevant hsc flag if -auto or -auto-all
534 $PROFcaf = ''; # set to relevant hsc flag if -caf-all
535 $PROFignore_scc = ''; # set to relevant parser flag if explicit sccs ignored
536 $UNPROFscc_auto = ''; # set to relevant hsc flag if forcing auto sccs without profiling
537 $TICKYing = ''; # set to t if compiling for ticky-ticky profiling
538 $PARing = ''; # set to p if compiling for PAR
539 $CONCURing = ''; # set to c if compiling for CONCURRENT
540 $GRANing = ''; # set to g if compiling for GRAN
541 $StkChkByPageFaultOK = 1; # may be set to 0 (false) for some builds
542 $Specific_hi_file = ''; # set by -ohi <file>; "-" for stdout
543 $Specific_dump_file = ''; # set by -odump <file>; "-" for stdout
544 $Using_dump_file = 0;
546 $Osuffix = ''; # default: use the normal suffix for that kind of output
548 $HiSuffix_prelude = '';
549 $Do_recomp_chkr = 0; # don't use the recompilatio checker unless asked
550 $Do_cc = -1; # a MAGIC indeterminate value; will be set to 1 or 0.
553 $Keep_hc_file_too = 0;
554 $Keep_s_file_too = 0;
555 $UseGhcInternals = 0; # if 1, may use GHC* modules
558 $Dump_parser_output = 0;
560 $Dump_asm_splitting_info = 0;
561 $NoImplicitPrelude = 0;
564 } # end of initDriverGlobals (Sigh)
566 # we split the argv passed to the driver into three:
571 # and files to be linked...
577 # cmd line options prefixing the unit we're compiling
582 We inject consistency-checking information into \tr{.hc} files (both
583 when created by the Haskell compiler and when compiled by the C
584 compiler), so that we can check that an executable is made from
585 consistently-built pieces. (The check is normally done just after
586 linking.) The checking is done by introducing/munging
587 \tr{what(1)}-style strings. Anyway, here are the relevant global
588 variables and their defaults:
590 $LinkChk = 1; # set to 0 if the link check should *not* be done
592 # major & minor version numbers; major numbers must always agree;
593 # minor disagreements yield a warning.
594 $HsC_major_version = 32;
595 $HsC_minor_version = 0;
596 $Cc_major_version = 36;
597 $Cc_minor_version = 1;
599 # options: these must always agree
600 $HsC_consist_options = ''; # we record, in this order:
601 # Build tag; debugging?
602 $Cc_consist_options = ''; # we record, in this order:
603 # Build tag; debugging?
606 %************************************************************************
608 \section[Driver-parse-argv]{Munge the command-line options}
610 %************************************************************************
612 Now slurp through the arguments.
615 #---------- user defined prelude ---------------------------------------
617 if (grep(/^-user-prelude$/, @ARGV)) {
619 # If ARGV contains -user-prelude we are compiling a piece of
620 # prelude for the user, probably with additional specialise pragmas
622 # We strip out the -O -f and -user-prelude flags provided on
623 # the command line and add the ones used to compile the prelude
624 # ToDo: get these options from a common definition in mkworld
626 # We also enable any options forced through with -user-prelude-force
628 # Hey, Check out this grep statement ;-) (PS)
630 @ARGV = grep((!/^-O/ && !/^-f/ && !/^-user-prelude$/) || s/^-user-prelude-force//,
634 '-fcompiling-ghc-internals=???', # ToDo!!!!
636 '-fshow-pragma-name-errs',
637 '-fshow-import-specs',
643 print STDERR "ghc: -user-prelude options:\n", "@ARGV", "\n";
646 &initDriverGlobals();
647 &splitCmdLine(@ARGV);
648 # Run through the cmd-line first time.
649 &processArgs(@Cmd_opts);
651 # Check to see if driver is only in the business
652 # to generate dependencies
653 if ( $Status == 0 && $Only_generate_deps ) {
655 push (@MkDependHS_flags, "-o$Osuffix") if $Osuffix;
656 push (@MkDependHS_flags, "-s$BuildTag") if $BuildTag;
657 local($to_do) = "$MkDependHS @MkDependHS_flags -- @Cmd_opts -- @Input_file" ;
658 &run_something($to_do, 'Haskell dependencies');
662 # if there are several input files,
663 # we don't allow \tr{-o <file>} or \tr{-ohi <file>} options...
664 # (except if linking, of course)
666 if ($#Input_file > 0 && ( ! $Do_lnkr )) {
667 if ( ($Specific_output_file ne '' && $Specific_output_file ne '-')
668 || ($Specific_hi_file ne '' && $Specific_hi_file ne '-') ) {
669 print STDERR "$Pgm: You can't use -o or -ohi options if you have multiple input files.\n";
670 print STDERR "\tPerhaps the -odir option will do what you want.\n";
675 # check for various pathological -o and -odir combinations...
676 if ($Specific_output_dir ne '' && $Specific_output_file ne '') {
677 if ($Specific_output_file eq '-') {
678 print STDERR "$Pgm: can't set output directory with -ohi AND have output to stdout\n";
680 } else { # amalgamate...
681 $Specific_output_file = "$Specific_output_dir/$Specific_output_file";
682 # ToDo: check we haven't got a junk name now...
683 $Specific_output_dir = ''; # reset
687 # crash and burn if there were errors
689 print STDERR $ShortUsage;
694 %************************************************************************
696 \section[Driver-post-argv-mangling]{Setup after reading options}
698 %************************************************************************
700 %************************************************************************
702 \subsection{Set up for optimisation level (\tr{-O} or whatever)}
704 %************************************************************************
706 We come now to the default ``wads of options'' that are turned on by
707 \tr{-O0} (do min optimisation), \tr{-O} (ordinary optimisation),
708 \tr{-O2} (aggressive optimisation), or no O-ish flag (compile speed is
711 The user can also specify his/her own list of options in a file; in
712 that case, the work is already done (see stuff about @minusO3@,
715 GHC allows very precise control of what happens during a compilation.
716 Core-to-Core and STG-to-STG passes can be run in any order, as many
717 times as you like. Individual transformations can be turned on or
720 Sadly, however, there are some interdependencies \& Things You Must
721 Not Do. Here is the list.
725 \item[\tr{-fspecialise}:]
726 The specialiser must have dependency-analysed input; but if you run
727 the simplifier to do this, you must not let it toss away unused
728 bindings! (The typechecker conveys some specialisation info via
729 ``unused'' bindings...)
731 \item[\tr{-ffloat-inwards}:]
732 Floating inwards should be done before strictness analysis, because
733 the latter will give better results.
735 \item[\tr{-fstatic-args}:]
736 The static-arguments-transformation pass {\em must} have the
737 simplifier run right after it.
739 \item[\tr{-fcalc-inlinings[12]}:]
740 Not required, but there may be slight gains by re-simplifying after
741 this is done. (You could then \tr{-fcalc-inlinings} again, just for
744 \item[\tr{-ffull-laziness}:]
745 The (outwards-)let-floater should be the {\em last} Core-to-Core pass
746 that's run. (Um, well, howzabout the simplifier just once more...)
751 \item[\tr{-fupdate-analysis}:]
752 It really really wants to be the last STG-to-STG pass that is run.
757 sub setupOptimiseFlags {
763 '-ffloat-lets-exposing-whnf',
764 '-ffloat-primops-ok',
766 # '-fdo-lambda-eta-expansion', # too complicated
768 # '-flet-to-case', # no strictness analysis, so...
769 $Oopt_PedanticBottoms,
770 # $Oopt_MonadEtaExpansion, # no thanks
772 # These two work fine, if you really want no simplification at all,
773 # for bizarre test reasons. But you get really terrible code if you use them,
774 # for example: let x = e in x
775 # with dozens of redundant thunks etc. So I'm leaving them out.
777 # '-fsimpl-uf-use-threshold0',
778 # '-fessential-unfoldings-only',
780 $Oopt_UnfoldingUseThreshold,
781 $Oopt_MaxSimplifierIterations,
784 # '-ffull-laziness', # removed 95/04 WDP following Andr\'e's lead
786 $Oopt_FinalStgProfilingMassage
789 @HsC_minusO_flags # NOTE: used for *both* -O and -O2 (some conditional bits)
791 '-fdo-eta-reduction',
793 # initial simplify: mk specialiser happy: minimum effort please
797 '-fkeep-spec-pragma-ids', # required before specialisation
799 # I don't understand why we want -fessential-unfoldings-only here
800 # If we have it, the following nasty thing happens:
804 # where "*" means exported.
805 # In the essential-unfoldings pass we still substitute f for g
806 # but we don't substitute E for f first. So we get
810 # The g=f will get reverse-substituted later, but it's untidy.
812 # '-fessential-unfoldings-only',
813 # '-fsimpl-uf-use-threshold0',
815 '-fmax-simplifier-iterations1',
816 $Oopt_PedanticBottoms,
819 ($Oopt_DoSpecialise) ? (
820 '-fspecialise-overloaded',
821 $Oopt_SpecialiseUnboxed,
825 '-fsimplify', # need dependency anal after specialiser ...
826 '\(', # need tossing before calc-inlinings ...
828 '-ffloat-lets-exposing-whnf',
829 '-ffloat-primops-ok',
833 # '-fdo-eta-reduction',
834 '-fdo-lambda-eta-expansion',
836 $Oopt_PedanticBottoms,
837 $Oopt_MonadEtaExpansion,
838 $Oopt_UnfoldingUseThreshold,
839 $Oopt_MaxSimplifierIterations,
842 #LATER: '-fcalc-inlinings1', -- pointless for 2.01
844 # ($Oopt_FoldrBuildWW) ? (
845 # '-ffoldr-build-ww-anal',
846 # '-ffoldr-build-worker-wrapper',
850 # '-ffloat-lets-exposing-whnf',
851 # '-ffloat-primops-ok',
855 # '-fdo-eta-reduction',
856 # '-fdo-lambda-eta-expansion',
858 # $Oopt_PedanticBottoms,
859 # $Oopt_MonadEtaExpansion,
860 # $Oopt_UnfoldingUseThreshold,
861 # $Oopt_MaxSimplifierIterations,
865 # this pass-ordering sequence was agreed by Simon and Andr\'e
866 # (WDP 94/07, 94/11).
869 ($Oopt_FoldrBuild) ? (
870 '-ffoldr-build-on', # desugar list comprehensions for foldr/build
874 '-fignore-inline-pragma', # **** NB!
875 '-fdo-foldr-build', # NB
877 '-ffloat-lets-exposing-whnf',
878 '-ffloat-primops-ok',
882 # '-fdo-eta-reduction',
883 '-fdo-lambda-eta-expansion', # After full laziness
885 $Oopt_PedanticBottoms,
886 $Oopt_MonadEtaExpansion,
887 $Oopt_UnfoldingUseThreshold,
888 $Oopt_MaxSimplifierIterations,
897 '-ffloat-lets-exposing-whnf',
898 '-ffloat-primops-ok',
902 '-fdo-eta-reduction',
903 '-fdo-lambda-eta-expansion',
905 ($Oopt_FoldrBuildInline),
906 # you need to inline foldr and build
907 ($Oopt_FoldrBuild) ? ('-fdo-foldr-build') : (),
908 # but do reductions if you see them!
909 $Oopt_PedanticBottoms,
910 $Oopt_MonadEtaExpansion,
911 $Oopt_UnfoldingUseThreshold,
912 $Oopt_MaxSimplifierIterations,
920 '-ffloat-lets-exposing-whnf',
921 '-ffloat-primops-ok',
925 # '-fdo-eta-reduction',
926 '-fdo-lambda-eta-expansion',
928 '-flet-to-case', # Aha! Only done after strictness analysis
929 $Oopt_PedanticBottoms,
930 $Oopt_MonadEtaExpansion,
931 $Oopt_UnfoldingUseThreshold,
932 $Oopt_MaxSimplifierIterations,
937 # Case-liberation for -O2. This should be after
938 # strictness analysis and the simplification which follows it.
942 # : "-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 \\)" ),
944 # Final clean-up simplification:
949 '-ffloat-lets-exposing-whnf',
950 '-ffloat-primops-ok',
954 # '-fdo-eta-reduction',
955 '-fdo-lambda-eta-expansion',
958 '-fignore-inline-pragma', # **** NB!
959 $Oopt_FoldrBuildInline,
960 ($Oopt_FoldrBuild) ? ('-fdo-foldr-build') : (),
961 # but still do reductions if you see them!
962 $Oopt_PedanticBottoms,
963 $Oopt_MonadEtaExpansion,
964 $Oopt_UnfoldingUseThreshold,
965 $Oopt_MaxSimplifierIterations,
970 #LATER: '-fcalc-inlinings2', -- pointless for 2.01
975 $Oopt_FinalStgProfilingMassage,
981 # SPECIAL FLAGS for -O2
989 Sort out what we're going to do about optimising. First, the @hsc@
990 flags and regular @cc@ flags to worry about:
992 if ( $OptLevel <= 0 ) {
994 # for this level, we tell the parser -fignore-interface-pragmas
995 push(@HsC_flags, '-fignore-interface-pragmas');
996 # and tell the compiler not to produce them
997 push(@HsC_flags, '-fomit-interface-pragmas');
999 &add_Hsc_flags( @HsC_minusNoO_flags );
1000 push(@CcBoth_flags, ($MinusO2ForC) ? '-O2' : '-O'); # not optional!
1002 } elsif ( $OptLevel == 1 || $OptLevel == 2 ) {
1004 &add_Hsc_flags( @HsC_minusO_flags );
1005 push(@CcBoth_flags, ($MinusO2ForC || $OptLevel == 2) ? '-O2' : '-O'); # not optional!
1006 # -O? to GCC is not optional! -O2 probably isn't worth it generally,
1007 # but it *is* useful in compiling the garbage collectors (so said
1008 # Patrick many moons ago...).
1010 } else { # -Ofile, then...
1012 &add_Hsc_flags( @HsC_minusO3_flags );
1013 push(@CcBoth_flags, ($MinusO2ForC) ? '-O2' : '-O'); # possibly to be elaborated...
1016 } # setupOptimiseFlags
1020 %************************************************************************
1022 \subsection{Check for consistency, etc.}
1024 %************************************************************************
1026 Sort out @$BuildTag@, @$PROFing@, @$CONCURing@, @$PARing@,
1027 @$GRANing@, @$TICKYing@:
1029 sub setupBuildFlags {
1032 # PROFILING stuff after argv mangling:
1034 # warn about any scc exprs found (in case scc used as identifier)
1035 push(@HsP_flags, '-W');
1037 # add -auto sccs even if not profiling !
1038 push(@HsC_flags, $UNPROFscc_auto) if $UNPROFscc_auto;
1041 push(@HsC_flags, $PROFauto) if $PROFauto;
1042 push(@HsC_flags, $PROFcaf) if $PROFcaf;
1043 #push(@HsC_flags, $PROFdict) if $PROFdict;
1045 $Oopt_FinalStgProfilingMassage = '-fmassage-stg-for-profiling';
1047 push(@HsP_flags, (($PROFignore_scc) ? $PROFignore_scc : '-S'));
1049 if ( $SplitObjFiles ) {
1050 # can't split with cost centres -- would need global and externs
1051 print STDERR "$Pgm: WARNING: splitting objects when profiling will *BREAK* if any _scc_s are present!\n";
1052 # (but it's fine if there aren't any _scc_s around...)
1053 # $SplitObjFiles = 0; # unset
1054 #not an error: for now: $Status++;
1057 #if ( $BuildTag ne '' ) {
1058 # local($b) = $BuildDescr{$BuildTag};
1059 # if ($CONCURing eq 'c') { print STDERR "$Pgm: Can't mix $b with -concurrent.\n"; exit 1; }
1060 # if ($PARing eq 'p') { print STDERR "$Pgm: Can't mix $b with -parallel.\n"; exit 1; }
1061 # if ($GRANing eq 'g') { print STDERR "$Pgm: Can't mix $b with -gransim.\n"; exit 1; }
1062 # if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix $b with -ticky.\n"; exit 1; }
1064 # # ok to have a user-way profiling build
1065 # # eval the profiling opts ... but leave user-way BuildTag
1066 # if ($PROFing eq 'p') { &processArgs(split(' ', $SetupOpts{'_p'})); } # eval($EvaldSetupOpts{'_p'}); }
1068 if ( $PROFing eq 'p' ) {
1069 if ($PARing eq 'p') { print STDERR "$Pgm: Can't do profiling with -parallel.\n"; exit 1; }
1070 if ($GRANing eq 'g') { print STDERR "$Pgm: Can't do profiling with -gransim.\n"; exit 1; }
1071 if ($TICKYing eq 't') { print STDERR "$Pgm: Can't do profiling with -ticky.\n"; exit 1; }
1072 $BuildTag = ($CONCURing eq 'c') ? '_mr' : '_p' ; # possibly "profiled concurrent"...
1074 } elsif ( $CONCURing eq 'c' ) {
1075 if ($PARing eq 'p') { print STDERR "$Pgm: Can't mix -concurrent with -parallel.\n"; exit 1; }
1076 if ($GRANing eq 'g') { print STDERR "$Pgm: Can't mix -concurrent with -gransim.\n"; exit 1; }
1077 $BuildTag = ($TICKYing eq 't') ? '_mt' : '_mc' ; # possibly "ticky concurrent"...
1078 # "profiled concurrent" already acct'd for...
1080 } elsif ( $PARing eq 'p' ) {
1081 if ($GRANing eq 'g') { print STDERR "$Pgm: Can't mix -parallel with -gransim.\n"; exit 1; }
1082 if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix -parallel with -ticky.\n"; exit 1; }
1085 if ( $Do_lnkr && ( ! $ENV{'PVM_ROOT'} || ! $ENV{'PVM_ARCH'} )) {
1086 print STDERR "$Pgm: both your PVM_ROOT and PVM_ARCH environment variables must be set for linking under -parallel.\n";
1090 } elsif ( $GRANing eq 'g' ) {
1091 if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix -gransim with -ticky.\n"; exit 1; }
1094 } elsif ( $TICKYing eq 't' ) {
1100 After the sanity checks, add flags to the necessary parts of the driver pipeline:
1103 if ( $BuildTag ne '' ) { # something other than normal sequential...
1105 local($Tag) = "${BuildTag}";
1106 $Tag =~ s/_//; # move the underscore to the back
1108 $HscOut = '-C='; # must go via C
1109 &processArgs(split(' ', $SetupOpts{$BuildTag}));
1110 # eval($EvaldSetupOpts{$BuildTag});
1114 Decide what the consistency-checking options are in force for this run:
1117 $HsC_consist_options = "${BuildTag},${DEBUGging}";
1118 $Cc_consist_options = "${BuildTag},${DEBUGging}";
1121 # Funny place to put it, but why not.
1123 if ( $HiSuffix_prelude eq '' ) {
1124 local($Tag) = "${BuildTag}";
1126 $Tag = "${Tag}_" if $Tag ne '';
1127 $HiSuffix_prelude="${Tag}hi";
1129 #push(@HsC_flags, "-hisuf-prelude=.${HiSuffix_prelude}"); # use appropriate Prelude .hi files
1130 #push(@HsC_flags, "-hisuf=.${HiSuffix}");
1135 %************************************************************************
1137 \subsection{Add on machine-specific C-compiler flags}
1139 %************************************************************************
1141 Shove on magical machine-specific options. We use \tr{unshift} to
1142 stick them on the {\em front} of the arrays, so that ``later''
1143 user-specified flags can clobber them (e.g., \tr{-U__STG_REV_TBLS__}).
1145 Note: a few ``always apply'' flags were set at the very beginning.
1150 if ($TargetPlatform =~ /^alpha-/) {
1151 # we know how to *mangle* asm for alpha
1152 unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1153 unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK;
1154 unshift(@CcBoth_flags, ('-static'));
1156 } elsif ($TargetPlatform =~ /^hppa/) {
1157 # we know how to *mangle* asm for hppa
1158 unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1159 unshift(@CcBoth_flags, ('-static'));
1161 # We don't put in '-mlong-calls', because it's only
1162 # needed for very big modules (sigh), and we don't want
1163 # to hobble ourselves further on all the other modules
1166 # [Dated comment (gcc-2.6.x?), -mlong-calls is no longer
1167 # a supported gcc HPPA flag]
1168 unshift(@CcBoth_flags, ('-D_HPUX_SOURCE'));
1169 # ___HPUX_SOURCE, not _HPUX_SOURCE, is #defined if -ansi!
1170 # (very nice, but too bad the HP /usr/include files don't agree.)
1172 } elsif ($TargetPlatform =~ /^i386-/) {
1173 # we know how to *mangle* asm for X86
1174 unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1175 unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK && $TargetPlatform !~ /nextstep/;
1176 # I do not know how to do STACK_CHECK_BY_PAGE_FAULT
1177 # on NeXTs (my fault, not theirs), so I don't.
1180 # -fno-defer-pop : basically the same game as for m68k
1182 # -fomit-frame-pointer : *must* ; because we're stealing
1183 # the fp (%ebp) for our register maps. *All* register
1184 # maps (in MachRegs.lh) must steal it.
1186 unshift(@CcRegd_flags_hc, '-fno-defer-pop');
1187 unshift(@CcRegd_flags, '-fomit-frame-pointer');
1188 unshift(@CcRegd_flags, "-DSTOLEN_X86_REGS=$StolenX86Regs");
1190 } elsif ($TargetPlatform =~ /^m68k-/) {
1191 # we know how to *mangle* asm for m68k
1192 unshift (@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1193 unshift (@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK && $TargetPlatform !~ /nextstep/;
1194 # I do not know how to do STACK_CHECK_BY_PAGE_FAULT
1195 # on NeXTs (my fault, not theirs), so I don't.
1198 # -fno-defer-pop : for the .hc files, we want all the pushing/
1199 # popping of args to routines to be explicit; if we let things
1200 # be deferred 'til after an STGJUMP, imminent death is certain!
1202 # -fomit-frame-pointer : *don't*
1203 # It's better to have a6 completely tied up being a frame pointer
1204 # rather than let GCC pick random things to do with it.
1205 # (If we want to steal a6, then we would try to do things
1206 # as on iX86, where we *do* steal the frame pointer [%ebp].)
1208 unshift(@CcRegd_flags_hc, '-fno-defer-pop');
1209 unshift(@CcRegd_flags, '-fno-omit-frame-pointer');
1210 # maybe gives reg alloc a better time
1211 # also: -fno-defer-pop is not sufficiently well-behaved without it
1213 } elsif ($TargetPlatform =~ /^mips-/) {
1214 # we (hope to) know how to *mangle* asm for MIPSen
1215 unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1216 unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK;
1217 unshift(@CcBoth_flags, ('-static'));
1219 } elsif ($TargetPlatform =~ /^powerpc-|^rs6000/) {
1220 # we know how to *mangle* asm for PowerPC
1221 # :-( unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1222 unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK;
1223 unshift(@CcBoth_flags, ('-static')); # always easier to start with
1224 unshift(@CcRegd_flags, ('-finhibit-size-directive')); # avoids traceback tables
1225 # unshift(@Ld_flags, ('-Xlinker -bbigtoc -Xlinker -bnoquiet')); # if we have lots of toc entries...
1226 unshift(@Ld_flags, ('-Xlinker -bbigtoc')); # just in case we have lots of toc entries...
1228 } elsif ($TargetPlatform =~ /^sparc-/) {
1229 # we know how to *mangle* asm for SPARC
1230 unshift(@CcRegd_flags, ('-D__STG_REV_TBLS__'));
1231 unshift(@CcRegd_flags, ('-DSTACK_CHECK_BY_PAGE_FAULT=1')) if $StkChkByPageFaultOK;
1234 } # end of setupMachOpts
1237 Same unshifting magic, but for special linker flags.
1239 The configure script determines whether the object file symbol tables
1240 have a leading underscore, and sets @LeadingUnderscore@ accordingly.
1241 (The driver script `sees' the setting of the @LeadingUnderscore@
1242 by having the Makefile prepend it).
1246 local($uscore) = ( ${LeadingUnderscore} eq 'YES' ) ? '_' : '';
1249 (($Ld_main) ? ( '-u', "${uscore}Main_" . $Ld_main . '_closure' ) : ()));
1251 ( '-u', "${uscore}PrelBase_Z91Z93_closure" # i.e., []
1252 ,'-u', "${uscore}PrelBase_IZh_static_info"
1253 ,'-u', "${uscore}PrelBase_CZh_static_info"
1254 ,'-u', "${uscore}PrelBase_False_inregs_info"
1255 ,'-u', "${uscore}PrelBase_True_inregs_info"
1256 ,'-u', "${uscore}STBase_SZh_static_info"
1257 ,'-u', "${uscore}DEBUG_REGS"
1261 } # end of setupLinkOpts
1265 %************************************************************************
1267 \subsection{Set up include paths and system-library enslurpment}
1269 %************************************************************************
1271 Now that we know what garbage-collector, etc., are required, we can
1272 finalise our list of libraries to slurp through, and generally Get
1277 # default includes must be added AFTER option processing
1278 if ( ! $INSTALLING ) {
1279 push (@Include_dir, "$TopPwd/${CURRENT_DIR}/${GHC_INCLUDE_DIR}");
1281 push (@Include_dir, "$InstLibDirGhc/includes");
1282 push (@Include_dir, "$InstLibDirGhc/includes");
1284 } # end of setupIncPaths
1289 push(@SysLibrary, ( '-lHS', '-lHS_cbits' )); # basic I/O and prelude stuff
1292 foreach $f (@SysLibrary) {
1293 next if $f =~ /_cbits/;
1294 $f .= $BuildTag if $f =~ /^-lHS/;
1297 # fiddle the TopClosure file name...
1298 $TopClosureFile =~ s/XXXX//;
1300 # Push library HSrts, plus boring clib bit
1301 push(@SysLibrary, "-lHSrts${BuildTag}");
1302 push(@SysLibrary, '-lHSclib');
1304 # RTS compiled with cygwin32, uses the WinMM API
1305 # to implement the itimers, since cygwin.dll does not
1306 # support it. Only reqd. for `ways' that use itimers.
1308 push(@SysLibrary, '-lwinmm') if $BuildTag ne '' && $TargetPlatform eq 'i386-unknown-cygwin32';
1310 # Push the pvm libraries
1311 if ($BuildTag eq '_mp') {
1312 $pvmlib = "$ENV{'PVM_ROOT'}/lib/$ENV{'PVM_ARCH'}";
1313 push(@SysLibrary, "-L$pvmlib", '-lpvm3', '-lgpvm3');
1314 if ( $ENV{'PVM_ARCH'} eq 'SUNMP' ) {
1315 push(@SysLibrary, '-lthread', '-lsocket', '-lnsl');
1316 } elsif ( $ENV{'PVM_ARCH'} eq 'SUN4SOL2' ) {
1317 push(@SysLibrary, '-lsocket', '-lnsl');
1321 # Push the GNU multi-precision arith lib; and the math library
1322 push(@SysLibrary, '-lgmp');
1323 push(@SysLibrary, '-lm');
1326 %************************************************************************
1328 \subsection{Check that this system was built to do what we are asking}
1330 %************************************************************************
1332 Before continuing we check that the appropriate build is available.
1335 #die "$Pgm: no BuildAvail?? $BuildTag\n" if $BuildDescr{$BuildTag} eq '' ; # sanity
1337 if ( $BuildDescr{$BuildTag} eq '' ) {
1338 print STDERR "$Pgm: a `", $BuildDescr{$BuildTag},
1339 "' \"build\" is not available with your GHC setup.\n";
1340 print STDERR "(It was not configured for it at your site.)\n";
1341 print STDERR $ShortUsage;
1345 } # end of setupSyslibs
1349 %************************************************************************
1351 \subsection{Final miscellaneous setup bits before we start going}
1353 %************************************************************************
1355 Record largest specific heapsize, if any.
1357 sub setupHeapStackSize {
1358 $Specific_heap_size = $Specific_heap_size * $Scale_sizes_by;
1359 push(@HsC_rts_flags, '-H'.$Specific_heap_size);
1360 $Specific_stk_size = $Specific_stk_size * $Scale_sizes_by;
1361 push(@HsC_rts_flags, "-K$Specific_stk_size");
1365 If no input or link files seen, then we let 'em feed in stdin; this is
1366 mainly for debugging.
1370 if ($#Input_file < 0 && $#Link_file < 0) {
1371 @Input_file = ( '-' );
1373 open(INF, "> $Tmp_prefix.hs") || &tidy_up_and_die(1,"Can't open $Tmp_prefix.hs\n");
1374 print STDERR "Enter your Haskell program, end with ^D (on a line of its own):\n";
1375 while (<>) { print INF $_; }
1376 close(INF) || &tidy_up_and_die(1,"Failed writing to $Tmp_prefix.hs\n");
1381 Tell the world who we are, if they asked.
1383 print STDERR "${PROJECTNAME}, version ${PROJECTVERSION}, patchlevel ${PROJECTPATCHLEVEL}\n"
1387 %************************************************************************
1389 \section[Driver-main-loop]{Main loop: Process input files, and link if required}
1391 %************************************************************************
1393 Process the input files; don't continue with linking if there are
1394 problems (global variable @$Status@ non-zero).
1396 foreach $ifile (@Input_file) {
1397 &ProcessInputFile($ifile);
1400 if ( $Status > 0 ) { # don't link if there were errors...
1401 print STDERR $ShortUsage;
1406 # append last minute flags linker and consistency flags
1413 Link if appropriate.
1416 local($libdirs) = '';
1418 # glue them together:
1419 push(@UserLibrary_dir, @SysLibrary_dir);
1421 $libdirs = '-L' . join(' -L',@UserLibrary_dir) if $#UserLibrary_dir >= 0;
1423 # for a linker, use an explicitly given one, or the going C compiler ...
1424 local($lnkr) = ( $Lnkr ) ? $Lnkr : $CcRegd;
1426 local($output) = ($Specific_output_file ne '') ? "-o $Specific_output_file" : '';
1427 @Files_to_tidy = ($Specific_output_file ne '') ? $Specific_output_file : 'a.out';
1429 local($to_do) = "$lnkr $Verbose @Ld_flags $output @Link_file $TopClosureFile $libdirs @UserLibrary @SysLibrary";
1430 &run_something($to_do, 'Linker');
1432 # finally, check the consistency info in the binary
1433 local($executable) = $Files_to_tidy[0];
1434 @Files_to_tidy = (); # reset; we don't want to nuke it if it's inconsistent
1437 # dynamically load consistency-chking code; then do it.
1438 require('ghc-consist.prl')
1439 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-consist.prl!\n");
1441 &chk_consistency_info ( $executable );
1444 # if PVM parallel stuff, we do truly weird things.
1445 # Essentially: (1) move the executable over to where PVM expects
1446 # to find it. (2) create a script in place of the executable
1447 # which will cause the program to be run, via SysMan.
1448 if ( $PARing eq 'p' ) {
1449 local($pvm_executable) = $executable;
1450 local($pvm_executable_base);
1452 if ( $pvm_executable !~ /^\// ) { # a relative path name: make absolute
1453 local($pwd) = `pwd`;
1455 $pwd =~ s/^\/tmp_mnt//;
1456 $pvm_executable = "$pwd/$pvm_executable";
1459 $pvm_executable =~ s|/|=|g; # make /s into =s
1460 $pvm_executable_base = $pvm_executable;
1462 $pvm_executable = $ENV{'PVM_ROOT'} . '/bin/' . $ENV{'PVM_ARCH'}
1463 . "/$pvm_executable";
1465 &run_something("$Rm -f $pvm_executable; $Cp -p $executable $pvm_executable && $Rm -f $executable", 'Moving binary to PVM land');
1467 # OK, now create the magic script for "$executable"
1468 open(EXEC, "> $executable") || &tidy_up_and_die(1,"$Pgm: couldn't open $executable to write!\n");
1469 print EXEC <<EOSCRIPT1;
1470 eval 'exec perl -S \$0 \${1+"\$@"}'
1471 if \$running_under_some_shell;
1472 # =!=!=!=!=!=!=!=!=!=!=!
1473 # This script is automatically generated: DO NOT EDIT!!!
1474 # Generated by Glasgow Haskell, version ${PROJECTVERSION} ${PROJECTPATCHLEVEL}
1476 \$pvm_executable = '$pvm_executable';
1477 \$pvm_executable_base = '$pvm_executable_base';
1478 \$SysMan = '$SysMan';
1481 print EXEC <<\EOSCRIPT2;
1482 # first, some magical shortcuts to run "commands" on the binary
1484 if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {
1486 system("$cmd $pvm_executable");
1490 # OK, really run it; process the args first
1491 $ENV{'PE'} = $pvm_executable_base;
1493 $nprocessors = 2; # the default
1497 # ToDo: handle --RTS
1498 args: while ($a = shift(@ARGV)) {
1499 if ( $a eq '+RTS' ) {
1501 } elsif ( $a eq '-RTS' ) {
1504 if ( $a eq '-d' && $in_RTS_args ) {
1506 } elsif ( $a =~ /^-N(\d+)/ && $in_RTS_args ) {
1509 push(@nonPVM_args, $a);
1513 local($return_val) = 0;
1514 system("$SysMan $debug $pvm_executable $nprocessors @nonPVM_args");
1516 system("mv $ENV{'HOME'}/$pvm_executable_base.???.gr .") if -f "$ENV{'HOME'}/$pvm_executable_base.001.gr";
1519 close(EXEC) || die "Failed closing $executable\n";
1520 chmod 0755, $executable;
1524 # that... that's all, folks!
1526 exit $Status; # will still be 0 if all went well
1529 %************************************************************************
1531 \section[Driver-do-one-file]{How to process a single input file}
1533 %************************************************************************
1536 sub ProcessInputFile {
1537 local($ifile) = @_; # input file name
1538 local($ifile_root); # root of or basename of input file
1539 local($ofile_target); # ultimate output file we hope to produce
1540 # from input file (need to know for recomp
1541 # checking purposes)
1542 local($hifile_target);# ditto (but .hi file)
1545 Handle the weirdity of input from stdin.
1547 if ($ifile ne '-') {
1548 ($ifile_root = $ifile) =~ s/\.[^\.\/]+$//;
1549 $ofile_target = # may be reset later...
1550 ($Specific_output_file ne '' && ! $Do_lnkr)
1551 ? $Specific_output_file
1552 : &odir_ify($ifile_root, 'o');
1553 $hifile_target= ($Specific_hi_file ne '')
1555 : "$ifile_root.$HiSuffix"; # ToDo: odirify?
1556 # NB: may change if $ifile_root isn't module name (??)
1558 $ifile = "$Tmp_prefix.hs"; # we know that's where we put the input
1559 $ifile_root = '_stdin';
1560 $ofile_target = '_stdout'; # gratuitous?
1561 $hifile_target= '_stdout'; # ditto?
1565 We need to decide what phases of the compilation system we will run
1566 over this file. The defaults are the ones established when processing
1567 flags. (That established what the last phase run for all files is.)
1569 We do the pre-recompilation-checker phases here; the rest later.
1573 Look at the suffix and decide what initial phases of compilation may
1574 be dropped off for this file. Also the rather boring business of
1575 which files are coming-in/going-out.
1577 Again, we'll do the post-recompilation-checker parts of this later.
1579 local($do_lit2pgm) = ($ifile =~ /\.lhs$/) ? 1 : 0;
1580 local($do_hscpp) = 1; # but "hscpp" might really be "cat"
1583 # names of the files to stuff between phases
1584 # defaults are temporaries
1585 local($in_lit2pgm) = $ifile;
1586 local($lit2pgm_hscpp) = "$Tmp_prefix.lpp";
1587 local($hscpp_hsc) = "$Tmp_prefix.cpp";
1588 local($hsc_hi) = "$Tmp_prefix.hi";
1589 local($cc_as_o) = "${Tmp_prefix}_o.s"; # temporary for raw .s file if opt C
1590 local($cc_as) = "$Tmp_prefix.s"; # mangled or hsc-produced .s code
1591 local($as_out) = $ofile_target;
1593 local($is_hc_file) = 1; #Is the C code .hc or .c? Assume .hc for now
1595 # OK, let's strip off some literate junk..
1596 if ($ifile =~ /\.lhs$/) {
1597 &runLit2pgm($in_lit2pgm, $lit2pgm_hscpp)
1599 $lit2pgm_hscpp = $ifile;
1605 # Scan the top of the de-litted file for {-# OPTIONS #-} pragmas
1606 &check_for_source_options($lit2pgm_hscpp,$ifile);
1607 # options found in the source file take a back seat, i.e., we scan
1608 # them first. Only process the command line again if source file
1609 # contained anything of interest *or* there's more than one
1610 # input file (we have to reset the options).
1612 if ( $#Input_file >= 0 || $#File_options >= 0) {
1613 #@File_options = (@File_options, @Cmd_opts);
1615 # Now process the command line
1616 &initDriverGlobals();
1617 &processArgs((@File_options,@Cmd_opts));
1618 print STDERR "\nEffective command line: " .
1619 join(' ',(@File_options,@Cmd_opts)) . "\n" if $Verbose;
1622 # Having got the effective command line scanned, set up
1623 # the various options in prep for some real work.
1625 # check the sanity of the BuildTag we're about to use,
1626 # and if needs be, add some more flags and setup to
1627 # the different phases.
1630 &setupOptimiseFlags();
1633 &setupHeapStackSize();
1636 # These two variables need to be set after the
1637 # command-line has been processed and the build options
1638 # have be seen set up. This is because command-line options
1639 # can control whether to compile vias C or not.
1641 local($do_cc) = ( $Do_cc != -1) # i.e., it was set explicitly
1643 : ( ($HscOut eq '-C=') ? 1 : 0 );
1644 local($do_as) = $Do_as;
1645 local($hsc_out) = ( $HscOut eq '-C=' ) ? "$Tmp_prefix.hc" : "$Tmp_prefix.s" ;
1647 if ($ifile =~ /.lhs$/ || $ifile =~ /.hs$/ ) {
1649 } elsif ($ifile =~ /\.hc$/ || $ifile =~ /_hc$/ ) { # || $ifile =~ /\.$Isuffix$/o) # ToDo: better
1650 $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
1652 } elsif ($ifile =~ /\.c$/) {
1653 $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
1654 $hsc_out = $ifile; $is_hc_file = 0;
1655 } elsif ($ifile =~ /\.s$/) {
1656 $do_hscpp = 0; $do_hsc = 0; $do_cc = 0;
1658 } else { # don't know what it is, but nothing to do herein...
1659 $do_hscpp = 0; $do_hsc = 0; $do_cc = 0; $do_as = 0;
1662 # hack to avoid running hscpp
1663 $HsCpp = $Cat if ! $Cpp_flag_set;
1665 &runHscpp($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc)
1669 We now think about whether to run hsc/cc or not (when hsc produces .s
1670 stuff, it effectively takes the place of both phases).
1672 To get the output file name right: for each phase that we are {\em
1673 not} going to run, set its input (i.e., the output of its preceding
1674 phase) to @"$ifile_root.<suffix>"@.
1676 local($going_interactive) = $HscOut eq '-N=' || $ifile_root eq '_stdin';
1679 # Warning issued if -keep-hc-file-too is used without
1680 # -fvia-C (or the equivalent)
1682 if ( $HscOut ne '-C=' && $Keep_hc_file_too ) {
1683 print STDERR "Warning: Native code generator to be used, -keep-hc-file-too will be ignored\n";
1686 if (! $do_cc && ! $do_as) { # stopping after hsc
1687 $hsc_out = ($Specific_output_file ne '')
1688 ? $Specific_output_file
1689 : &odir_ify($ifile_root, ($HscOut eq '-C=') ? 'hc' : 's');
1691 $ofile_target = $hsc_out; # reset
1694 if (! $do_as) { # stopping after gcc (or hsc)
1695 $cc_as = ($Specific_output_file ne '')
1696 ? $Specific_output_file
1697 : &odir_ify($ifile_root, ( $Only_preprocess_C ) ? 'i' : 's');
1699 $ofile_target = $cc_as; # reset
1705 Now the Haskell compiler, C compiler, and assembler
1709 &runHscAndProcessInterfaces( $ifile, $hscpp_hsc, $ifile_root,
1710 $ofile_target, $hifile_target);
1714 # # if we're going to split up object files, #delete! andre
1715 # # we inject split markers into the .hc file now #delete! andre
1716 # if ( $HscOut eq '-C=' && $SplitObjFiles ) { #delete! andre
1717 # &inject_split_markers ( $hsc_out ); #delete! andre
1719 &runGcc ($is_hc_file, $hsc_out, $cc_as_o);
1720 &runMangler($is_hc_file, $cc_as_o, $cc_as, $ifile_root);
1723 &split_asm_file($cc_as) if $do_as && $SplitObjFiles;
1725 # save a copy of the .s file..
1726 &saveIntermediate($ifile_root , "s" , $cc_as) if ($do_as && $Keep_s_file_too);
1727 &runAs($as_out, $ifile_root) if $do_as;
1730 Finally, decide what to queue up for linker input.
1732 # tentatively assume we will eventually produce linker input:
1733 push(@Link_file, &odir_ify($ifile_root, 'o'));
1735 #ToDo: local($or_isuf) = ($Isuffix eq '') ? '' : "|$Isuffix";
1737 if ( $ifile !~ /\.(lhs|hs|hc|c|s)$/ && $ifile !~ /_hc$/ ) {
1738 print STDERR "$Pgm: don't recognise suffix on `$ifile'; passing it through to linker\n"
1739 if $ifile !~ /\.a$/;
1741 # oops; we tentatively pushed the wrong thing; fix & do the right thing
1742 pop(@Link_file); push(@Link_file, $ifile);
1746 } # end of ProcessInputFile
1749 %************************************************************************
1751 \section[Driver-run-phases]{Routines to run the various phases}
1753 %************************************************************************
1757 local($in_lit2pgm, $lit2pgm_hscpp) = @_;
1759 local($to_do) = "echo '#line 1 \"$in_lit2pgm\"' > $lit2pgm_hscpp && ".
1760 "$Unlit @Unlit_flags $in_lit2pgm - >> $lit2pgm_hscpp";
1761 @Files_to_tidy = ( $lit2pgm_hscpp );
1763 &run_something($to_do, 'literate pre-processor');
1769 local($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc) = @_;
1773 if ($HsCpp eq $Cat) {
1774 $to_do = "echo '#line 1 \"$in_lit2pgm\"' > $hscpp_hsc && ".
1775 "$HsCpp $lit2pgm_hscpp >> $hscpp_hsc";
1776 @Files_to_tidy = ( $hscpp_hsc );
1777 &run_something($to_do, 'Ineffective C pre-processor');
1779 local($includes) = '-I' . join(' -I',@Include_dir);
1780 $to_do = "echo '#line 1 \"$in_lit2pgm\"' > $hscpp_hsc && ".
1781 "$HsCpp $Verbose $genSPECS_flag @HsCpp_flags -D__HASKELL1__=$Haskell1Version -D__GLASGOW_HASKELL__=$GhcVersionInfo $includes $lit2pgm_hscpp >> $hscpp_hsc";
1782 @Files_to_tidy = ( $hscpp_hsc );
1783 &run_something($to_do, 'Haskellised C pre-processor');
1790 sub runHscAndProcessInterfaces {
1791 local($ifile, $hscpp_hsc, $ifile_root, $ofile_target, $hifile_target) = @_;
1793 # $ifile is the original input file
1794 # $hscpp_hsc post-unlit, post-cpp, etc., input file
1795 # $ifile_root input filename minus suffix
1796 # $ofile_target the output file that we ultimately hope to produce
1797 # $hifile_target the .hi file ... (ditto)
1799 local($source_unchanged) = 1;
1801 # Check if the source file is up to date relative to the target; in
1802 # that case we say "source is unchanged" and let the compiler bail out
1803 # early if the import usage information allows it.
1805 ($i_dev,$i_ino,$i_mode,$i_nlink,$i_uid,$i_gid,$i_rdev,$i_size,
1806 $i_atime,$i_mtime,$i_ctime,$i_blksize,$i_blocks) = stat($ifile);
1808 # The informational messages below are now conditional on -v being set -- SOF
1809 if ( ! -f $ofile_target ) {
1810 print STDERR "$Pgm:compile:Output file $ofile_target doesn't exist\n" if $Verbose;
1811 $source_unchanged = 0;
1814 ($o_dev,$o_ino,$o_mode,$o_nlink,$o_uid,$o_gid,$o_rdev,$o_size,
1815 $o_atime,$o_mtime,$o_ctime,$o_blksize,$o_blocks) = stat(_); # stat info from -f test
1817 if ( ! -f $hifile_target ) {
1818 print STDERR "$Pgm:compile:Interface file $hifile_target doesn't exist\n" if $Verbose;
1819 $source_unchanged = 0;
1822 ($hi_dev,$hi_ino,$hi_mode,$hi_nlink,$hi_uid,$hi_gid,$hi_rdev,$hi_size,
1823 $hi_atime,$hi_mtime,$hi_ctime,$hi_blksize,$hi_blocks) = stat(_); # stat info from -f test
1825 if ($i_mtime > $o_mtime) {
1826 print STDERR "$Pgm:recompile:Input file $ifile newer than $ofile_target\n" if $Verbose;
1827 $source_unchanged = 0;
1830 # So if source_unchanged is still "1", we pass on the good news to the compiler
1831 # The -recomp flag can disable this, forcing recompilation
1832 if ($Do_recomp_chkr && $source_unchanged) {
1833 push(@HsC_flags, '-fsource-unchanged');
1838 &runHsc($ifile_root, $hsc_out, $hsc_hi, $going_interactive);
1840 # See if it bailed out early, saying nothing needed doing.
1841 # We work this out by seeing if it created an output .hi file
1843 if ( ! -f $hsc_hi && $ProduceHi !~ /-nohifile=/ ) {
1844 # Doesn't exist, so we bailed out early.
1845 # Tell the C compiler and assembler not to run
1846 $do_cc = 0; $do_as = 0;
1848 # Update dependency info, touch both object file and
1849 # interface file, so that the following invariant is
1852 # a dependent module's interface file should after recompilation
1853 # checking be newer than the interface files of its imports.
1855 # That is, if module A's interface file changes, then module B
1856 # (which import from A) needs to be checked.
1857 # If A's change does not affect B, which causes the compiler to bail
1858 # out early, we still need to touch the interface file of B. The reason
1859 # for this is that B may export A's interface.
1861 &run_something("touch $ofile_target",
1862 "Touch $ofile_target, to propagate dependencies") if $HscOut ne '-N=';
1863 &run_something("touch $hifile_target",
1864 "Touch $hifile_target, to propagate dependencies") if $ProduceHi =~ /-nohifile=/ ;
1868 # Didn't bail out early (new .hi file) so we thunder on
1870 # If non-interactive, heave in the consistency info at the end
1871 # NB: pretty hackish (depends on how $output is set)
1872 if ( ! $going_interactive ) {
1873 if ( $HscOut eq '-C=' ) {
1874 $to_do = "echo 'static char ghc_hsc_ID[] = \"\@(#)hsc $ifile\t$HsC_major_version.$HsC_minor_version,$HsC_consist_options\";' >> $hsc_out";
1876 } elsif ( $HscOut eq '-S=' ) {
1877 local($consist) = "hsc.$ifile.$HsC_major_version.$HsC_minor_version.$HsC_consist_options";
1878 $consist =~ s/,/./g;
1879 $consist =~ s/\//./g;
1880 $consist =~ s/-/_/g;
1881 $consist =~ s/[^A-Za-z0-9_.]/ZZ/g; # ToDo: properly?
1882 $to_do = "echo '\n\t.text\n$consist:' >> $hsc_out";
1884 &run_something($to_do, 'Pin on Haskell consistency info');
1888 # Interface-handling is important enough to live off by itself
1889 if ( $ProduceHi !~ /-nohifile=/ ) { # If we've produced one, process it.
1890 require('ghc-iface.prl') || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-iface.prl!\n");
1891 &postprocessHiFile($hsc_hi, $hifile_target, $going_interactive);
1893 # if we're going to split up object files,
1894 # we inject split markers into the .hc file now
1895 if ( $HscOut eq '-C=' && $SplitObjFiles ) {
1896 &inject_split_markers ( $hsc_out );
1899 # save a copy of the .hc file, even if we are carrying on...
1900 if ($HscOut eq '-C=' && $do_cc && $Keep_hc_file_too) {
1901 &saveIntermediate($ifile_root , "hc" , $hsc_out);
1911 local($ifile_root, $hsc_out, $hsc_hi, $going_interactive) = @_;
1913 # prepend comma to HsP flags (so hsc can tell them apart...)
1914 foreach $a ( @HsP_flags ) { $a = ",$a" unless $a =~ /^,/; }
1916 &makeHiMap() unless $HiMapDone;
1917 #print STDERR "HiIncludes: $HiIncludeString\n";
1918 push(@HsC_flags, "-himap=$HiIncludeString");
1920 # here, we may produce .hc/.s and/or .hi files
1921 local($output) = '';
1922 @Files_to_tidy = ();
1924 if ( $going_interactive ) {
1925 # don't need .hi unless going to show it on stdout:
1926 $ProduceHi = '-nohifile=' if ! $HiOnStdout;
1927 $do_cc = 0; $do_as = 0; $Do_lnkr = 0; # and we won't go any further...
1930 # set up for producing output/.hi; note that flag twiddling
1931 # may mean that nothing will actually be produced:
1932 $output = "$ProduceHi$hsc_hi $HscOut$hsc_out";
1933 @Files_to_tidy = ( $hsc_hi, $hsc_out );
1935 # if we're compiling foo.hs, we want the GC stats to end up in foo.stat
1936 if ( $CollectingGCstats ) {
1937 push(@HsC_rts_flags, "-S$ifile_root.stat");
1938 push(@Files_to_tidy, "$ifile_root.stat");
1941 if ( $CollectGhcTimings ) { # assume $RTS_style eq 'ghc'
1942 # emit nofibbish time/bytes-alloc stats to stderr;
1943 # see later .stat file post-processing
1944 push(@HsC_rts_flags, "-s$Tmp_prefix.stat");
1945 push(@Files_to_tidy, "$Tmp_prefix.stat");
1949 if ($Specific_dump_file ne '') {
1950 $dump = "2>> $Specific_dump_file";
1951 $Using_dump_file = 1;
1955 $to_do = "$HsC @HsP_flags ,$hscpp_hsc $dump @HsC_flags $CoreLint $StgLint $Verbose $output +RTS @HsC_rts_flags";
1956 &run_something($to_do, 'Haskell compiler');
1958 # finish business w/ nofibbish time/bytes-alloc stats
1959 &process_ghc_timings() if $CollectGhcTimings;
1963 Use \tr{@Import_dir} and \tr{@SysImport_dir} to make a tmp file
1964 of (module-name, pathname) pairs, one per line, separated by a space.
1967 $HiIncludeString = (); # dir1:dir2:dir3, to pass to GHC
1971 # collect in %HiMap; write later; also used elsewhere in driver
1973 local($mod, $path, $d, $e);
1975 # reset the global variables:
1977 $HiIncludeString = (); # dir1:dir2:dir3, to pass to GHC
1979 foreach $d ( @Import_dir ) {
1980 if ($HiIncludeString) {
1981 $HiIncludeString = "$HiIncludeString:${d}%.${HiSuffix}";
1983 $HiIncludeString = "$d%.${HiSuffix}";
1988 foreach $d ( @SysImport_dir ) {
1989 if ($HiIncludeString) {
1990 $HiIncludeString = "$HiIncludeString:${d}%.${HiSuffix_prelude}";
1992 $HiIncludeString = "${d}%.${HiSuffix_prelude}";
2001 %************************************************************************
2003 \section[Driver-misc-utils]{Miscellaneous utilities}
2005 %************************************************************************
2007 %************************************************************************
2009 \subsection[Driver-odir-ify]{@odir_ify@: Mangle filename if \tr{-odir} set}
2011 %************************************************************************
2015 local($ofile,$def_suffix) = @_;
2017 return(($Osuffix eq '') ? "$ofile.$def_suffix" : "$ofile.$Osuffix" );
2021 local($orig_file, $def_suffix) = @_;
2022 if ($Specific_output_dir eq '') { # do nothing
2023 &osuf_ify($orig_file, $def_suffix);
2025 local ($orig_file_only);
2026 ($orig_file_only = $orig_file) =~ s|.*/||;
2027 &osuf_ify("$Specific_output_dir/$orig_file_only",$def_suffix);
2034 local($is_hc_file, $hsc_out, $cc_as_o) = @_;
2036 local($includes) = '-I' . join(' -I', @Include_dir);
2039 local($c_flags) = "@CcBoth_flags";
2040 local($ddebug_flag) = ( $DEBUGging ) ? '-DDEBUG' : '';
2042 # "input" files to use that are not in some weird directory;
2043 # to help C compilers grok .hc files [ToDo: de-hackify]
2044 local($cc_help) = "ghc$$.c";
2045 local($cc_help_s) = "ghc$$.s";
2048 $s_output = ($is_hc_file || $TargetPlatform =~ /^(powerpc|rs6000|hppa|i386)/) ? $cc_as_o : $cc_as;
2049 $c_flags .= " @CcRegd_flags";
2050 $c_flags .= ($is_hc_file) ? " @CcRegd_flags_hc" : " @CcRegd_flags_c";
2052 # C compiler won't like the .hc extension. So we create
2053 # a tmp .c file which #include's the needful.
2054 open(TMP, "> $cc_help") || &tidy_up_and_die(1,"$Pgm: failed to open `$cc_help' (to write)\n");
2055 if ( $is_hc_file ) {
2057 #ifdef __STG_GCC_REGS__
2058 # if ! (defined(MAIN_REG_MAP) || defined(MARK_REG_MAP) || defined(SCAN_REG_MAP) || defined(SCAV_REG_MAP) || defined(FLUSH_REG_MAP))
2059 # define MAIN_REG_MAP
2062 #include "stgdefs.h"
2064 # user may have asked for #includes to be injected...
2065 print TMP @CcInjects if $#CcInjects >= 0;
2067 # heave in the consistency info
2068 print TMP "static char ghc_cc_ID[] = \"\@(#)cc $ifile\t$Cc_major_version.$Cc_minor_version,$Cc_consist_options\";\n";
2070 # and #include the real source
2071 print TMP "#include \"$hsc_out\"\n";
2072 close(TMP) || &tidy_up_and_die(1,"Failed writing to $cc_help\n");
2074 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 )";
2075 # note: __GLASGOW_HASKELL__ is pointedly *not* #defined at the C level.
2076 if ( $Only_preprocess_C ) { # HACK ALERT!
2077 $to_do =~ s/ -S\b//g;
2079 @Files_to_tidy = ( $cc_help, $cc_help_s, $s_output );
2080 $PostprocessCcOutput = 1; # hack, dear hack...
2081 &run_something($to_do, 'C compiler');
2082 $PostprocessCcOutput = 0;
2083 unlink($cc_help, $cc_help_s);
2089 local($is_hc_file, $cc_as_o, $cc_as, $ifile_root) = @_;
2091 if ( $is_hc_file ) {
2092 # dynamically load assembler-fiddling code, which we are about to use:
2093 require('ghc-asm.prl')
2094 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm.prl!\n");
2097 print STDERR `cat $cc_as_o` if $Dump_raw_asm; # to stderr, before mangling
2100 # post-process the assembler [.hc files only]
2101 &mangle_asm($cc_as_o, $cc_as);
2105 #OLD: local($target) = 'oops';
2106 #OLD: $target = '-alpha' if $TargetPlatform =~ /^alpha-/;
2107 #OLD: $target = '-hppa' if $TargetPlatform =~ /^hppa/;
2108 #OLD: $target = '-old-asm' if $TargetPlatform =~ /^i386-/;
2109 #OLD: $target = '-m68k' if $TargetPlatform =~ /^m68k-/;
2110 #OLD: $target = '-mips' if $TargetPlatform =~ /^mips-/;
2111 #OLD: $target = '' if $TargetPlatform =~ /^powerpc-/;
2112 #OLD: $target = '-solaris' if $TargetPlatform =~ /^sparc-sun-solaris2/;
2113 #OLD: $target = '-sparc' if $TargetPlatform =~ /^sparc-sun-sunos4/;
2115 #OLD: if ( $target ne '' ) {
2116 #OLD: require("ghc-asm$target.prl")
2117 #OLD: || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm$target.prl!\n");
2118 #OLD: &mangle_asm($cc_as_o, "$cc_as-2"); # the OLD one!
2119 #OLD: &run_something("$Cmp -s $cc_as-2 $cc_as || $Diff $cc_as-2 $cc_as 1>&2 || exit 0",
2120 #OLD: "Diff'ing old and new mangled .s files"); # NB: to stderr
2123 } elsif ($TargetPlatform =~ /^hppa/) {
2124 # minor mangling of non-threaded files for hp-pa only
2125 require('ghc-asm.prl')
2126 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-hppa.prl!\n");
2127 &mini_mangle_asm_hppa($cc_as_o, $cc_as);
2129 } elsif ($TargetPlatform =~ /^powerpc|^rs6000/) {
2130 # minor mangling of non-threaded files for powerpcs and rs6000s
2131 require('ghc-asm.prl')
2132 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-powerpc.prl!\n");
2133 &mini_mangle_asm_powerpc($cc_as_o, $cc_as);
2134 } elsif ($TargetPlatform =~ /^i386/) {
2135 # extremely-minor OFFENSIVE mangling of non-threaded just one file
2136 require('ghc-asm.prl')
2137 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm.prl!\n");
2138 &mini_mangle_asm_i386($cc_as_o, $cc_as);
2141 # save a copy of the .s file, even if we are carrying on...
2142 #if ($do_as && $Keep_s_file_too) {
2143 # &saveIntermediate($ifile_root , "s" , $cc_as);
2150 local($as_out, $ifile_root) = @_;
2152 local($asmblr) = ( $As ) ? $As : $CcRegd;
2154 if ( ! $SplitObjFiles ) {
2155 local($to_do) = "$asmblr -o $as_out -c @As_flags $cc_as";
2156 @Files_to_tidy = ( $as_out );
2157 &run_something($to_do, 'Unix assembler');
2159 } else { # more complicated split-ification...
2161 # must assemble files $Tmp_prefix__[1 .. $NoOfSplitFiles].s
2163 # If -odir is used, great, just pin it in front of the
2164 # generated split file names. If it hasn't been set, we
2165 # snatch it from the ifile_root.
2169 if ( $Specific_output_dir eq '' ) {
2170 $Specific_output_dir = ${ifile_root};
2173 for ($f = 1; $f <= $NoOfSplitFiles; $f++ ) {
2174 local($split_out) = &odir_ify("${ifile_root}__${f}",'o');
2175 local($to_do) = "$asmblr -o $split_out -c @As_flags ${Tmp_prefix}__${f}.s";
2176 @Files_to_tidy = ( $split_out );
2178 &run_something($to_do, 'Unix assembler');
2184 %************************************************************************
2186 \subsection[Driver-run-something]{@run_something@: Run a phase}
2188 %************************************************************************
2192 local($str_to_do, $tidy_name) = @_;
2194 print STDERR "\n$tidy_name:\n\t" if $Verbose;
2195 print STDERR "$str_to_do\n" if $Verbose;
2197 if ($Using_dump_file) {
2198 open(DUMP, ">> $Specific_dump_file")
2199 || &tidy_up_and_die(1,"$Pgm: failed to open `$Specific_dump_file'\n");
2200 print DUMP "\nCompilation Dump for: $str_to_do\n\n";
2202 || &tidy_up_and_die(1,"$Pgm: failed closing `$Specific_dump_file'\n");
2205 local($return_val) = 0;
2207 if ( length($str_to_do) > 4000) {
2208 # 4000 - on the random side, just like the *real* ARG_MAX
2211 # With some shells, command lines of this length may
2212 # very well cause trouble. To safeguard against this, we squirrel the
2213 # command into a file and exec that.
2214 local ($sh) = $ENV{'REAL_SHELL'};
2215 print STDERR "Backup plan A: saving cmd line in ${Tmp_prefix}.sh and executing that with $sh\n" if $Verbose;
2216 open (TEMP, "> ${Tmp_prefix}.sh") ||
2217 &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.sh'\n");
2218 print TEMP "$Time $str_to_do\n";
2220 &tidy_up_and_die(1,"$Pgm: failed closing `$Tmp_prefix.sh'\n");
2221 system("$sh $Tmp_prefix.sh");
2224 unlink "${Tmp_prefix}.sh";
2226 system("$Time $str_to_do");
2230 if ( $PostprocessCcOutput ) { # hack, continued
2231 open(CCOUT, "< $Tmp_prefix.ccout")
2232 || &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.ccout'\n");
2234 next if /attribute directive ignored/;
2235 next if /call-clobbered/;
2236 next if /from .*COptRegs\.lh/;
2237 next if /from .*(stg|rts)defs\.h:/;
2238 next if /from ghc\d+.c:\d+:/;
2239 next if /from .*\.lc/;
2240 next if /from .*SMinternal\.l?h/;
2241 next if /ANSI C does not support \`long long\'/;
2242 next if /warning:.*was declared \`extern\' and later \`static\'/;
2243 next if /warning: assignment discards \`const\' from pointer target type/;
2244 next if /: At top level:$/;
2245 next if /: In function \`.*\':$/;
2246 next if /\`ghc_cc_ID\' defined but not used/;
2249 close(CCOUT) || &tidy_up_and_die(1,"$Pgm: failed closing `$Tmp_prefix.ccout'\n");
2252 if ($return_val != 0) {
2253 if ($Using_dump_file) {
2254 print STDERR "Compilation Errors dumped in $Specific_dump_file\n";
2257 &tidy_up_and_die($return_val, '');
2259 $Using_dump_file = 0;
2263 %************************************************************************
2265 \subsection[Driver-ghc-timing]{Emit nofibbish GHC timings}
2267 %************************************************************************
2269 NB: nearly the same as in @runstdtest@ script.
2272 sub process_ghc_timings {
2273 local($StatsFile) = "$Tmp_prefix.stat";
2274 local($SysSpecificTiming) = 'ghc';
2276 open(STATS, $StatsFile) || die "Failed when opening $StatsFile\n";
2277 local($tot_live) = 0; # for calculating avg residency
2280 $tot_live += $1 if /^\s*\d+\s+\d+\s+\d+\.\d+\%\s+(\d+)\s+\d+\.\d+\%/;
2282 $BytesAlloc = $1 if /^\s*([0-9,]+) bytes allocated in the heap/;
2284 if ( /^\s*([0-9,]+) bytes maximum residency .* (\d+) sample/ ) {
2285 $MaxResidency = $1; $ResidencySamples = $2;
2288 $GCs = $1 if /^\s*([0-9,]+) garbage collections? performed/;
2290 if ( /^\s*INIT\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2291 $InitTime = $1; $InitElapsed = $2;
2292 } elsif ( /^\s*MUT\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2293 $MutTime = $1; $MutElapsed = $2;
2294 } elsif ( /^\s*GC\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2295 $GcTime = $1; $GcElapsed = $2;
2298 close(STATS) || die "Failed when closing $StatsFile\n";
2299 if ( defined($ResidencySamples) && $ResidencySamples > 0 ) {
2300 $AvgResidency = int ($tot_live / $ResidencySamples) ;
2303 # warn about what we didn't find
2304 print STDERR "Warning: BytesAlloc not found in stats file\n" unless defined($BytesAlloc);
2305 print STDERR "Warning: GCs not found in stats file\n" unless defined($GCs);
2306 print STDERR "Warning: InitTime not found in stats file\n" unless defined($InitTime);
2307 print STDERR "Warning: InitElapsed not found in stats file\n" unless defined($InitElapsed);
2308 print STDERR "Warning: MutTime not found in stats file\n" unless defined($MutTime);
2309 print STDERR "Warning: MutElapsed not found in stats file\n" unless defined($MutElapsed);
2310 print STDERR "Warning: GcTime inot found in stats file\n" unless defined($GcTime);
2311 print STDERR "Warning: GcElapsed not found in stats file\n" unless defined($GcElapsed);
2313 # things we didn't necessarily expect to find
2314 $MaxResidency = 0 unless defined($MaxResidency);
2315 $AvgResidency = 0 unless defined($AvgResidency);
2316 $ResidencySamples = 0 unless defined($ResidencySamples);
2319 $BytesAlloc =~ s/,//g;
2320 $MaxResidency =~ s/,//g;
2322 $InitTime =~ s/,//g;
2323 $InitElapsed =~ s/,//g;
2325 $MutElapsed =~ s/,//g;
2327 $GcElapsed =~ s/,//g;
2329 # print out what we found
2330 print STDERR "<<$SysSpecificTiming: ",
2331 "$BytesAlloc bytes, $GCs GCs, $AvgResidency/$MaxResidency avg/max bytes residency ($ResidencySamples samples), $InitTime INIT ($InitElapsed elapsed), $MutTime MUT ($MutElapsed elapsed), $GcTime GC ($GcElapsed elapsed)",
2332 " :$SysSpecificTiming>>\n";
2339 %************************************************************************
2341 \subsection[Driver-dying]{@tidy_up@ and @tidy_up_and_die@: Dying gracefully}
2343 %************************************************************************
2347 local($to_do) = "\n$Rm $Tmp_prefix*";
2348 if ( $Tmp_prefix !~ /^\s*$/ ) {
2349 print STDERR "$to_do\n" if $Verbose;
2354 sub tidy_up_and_die {
2355 local($return_val, $msg) = @_;
2357 # delete any files to tidy
2358 print STDERR "deleting... @Files_to_tidy\n" if $Verbose && $#Files_to_tidy >= 0;
2359 unlink @Files_to_tidy if $#Files_to_tidy >= 0;
2363 exit (($return_val == 0) ? 0 : 1);
2367 %************************************************************************
2369 \subsection[Driver-arg-with-arg]{@grab_arg_arg@: Do an argument with an argument}
2371 %************************************************************************
2373 Some command-line arguments take an argument, e.g.,
2374 \tr{-Rmax-heapsize} expects a number to follow. This can either be
2375 given a part of the same argument (\tr{-Rmax-heapsize8M}) or as the
2376 next argument (\tr{-Rmax-heapsize 8M}). We allow both cases.
2378 Note: no error-checking; \tr{-Rmax-heapsize -Rgc-stats} will silently
2379 gobble the second argument (and probably set the heapsize to something
2383 local(*Args, $option, $rest_of_arg) = @_;
2386 return($rest_of_arg);
2387 } elsif ($#Args >= 0) {
2388 local($temp) = $Args[0]; shift(@Args);
2391 print STDERR "$Pgm: no argument following $option option\n";
2402 #Not in HsC_antiflag ## NO!: and not already in HsC_flags
2404 foreach $f ( @HsC_antiflags ) {
2405 return(0) if $flag eq $f;
2407 # foreach $f ( @HsC_flags ) {
2408 # return(0) if $flag eq $f;
2413 sub squashHscFlag { # pretty terrible
2417 foreach $f ( @HsC_flags ) {
2418 if ($flag eq $f) { $f = ''; }
2426 foreach $f ( @flags ) {
2427 push( @HsC_flags, $f ) if &isntAntiFlag($f);
2432 Source files may have {-# OPTIONS ... #-} pragmas at the top, containing
2433 command line options we want to append to collection of commands specified
2434 directly. @check_for_source_options@ looks at the top of a de-lit'ified Haskell
2435 file for any such pragmas:
2438 sub check_for_source_options {
2439 local($file,$ifile) = @_;
2440 local($comment_start,$comment_end);
2442 if ($ifile =~ /\.hc$/ ||
2445 $ifile =~ /_s$/ ) { # `Real' C intermediate
2446 $comment_start = "/\\*";
2447 $comment_end = "\\*/";
2448 } else { # Assume it is a file containing Haskell source
2449 $comment_start = "{-#";
2450 $comment_end = "#-}";
2453 open(FILE,$file) || return(1); # No big loss
2456 if ( /^${comment_start} OPTIONS (.*)${comment_end}$/ ) {
2457 # add the options found at the back of the command line.
2458 local(@entries) = split(/\s+/,$1);
2459 print STDERR "Found OPTIONS " . join(' ',@entries) . " in $file\n" if $Verbose;
2460 push(@File_options, @entries);
2462 elsif ( /^$/ ) { # ignore empty lines
2465 elsif ( /^#line.+$/ ) { # ignore comment lines
2468 else { # stop looking, something non-empty / not
2469 # ${comment_start} OPTIONS .. ${comment_end} encountered.
2470 close(FILE);return(0);
2479 We split the initial argv up into three arrays:
2485 the reason for doing so is to be able to deal
2486 with {-# OPTIONS #-} pragma in source files properly.
2492 arg: while($_ = $args[0]) {
2494 # sigh, we have to deal with these -option arg specially here.
2495 /^-(tmpdir|odir|o|isuf|osuf|hisuf|hisuf-prelude|odump|syslib)$/ &&
2496 do { push(@Cmd_opts, $_); push(@Cmd_opts,$args[0]); shift(@args); next arg; };
2497 /^-./ && do { push(@Cmd_opts, $_); next arg; };
2500 push(@Link_file, $_);
2502 push(@Input_file, $_);
2505 # input files must exist:
2507 print STDERR "$Pgm: input file doesn't exist: $_\n";
2515 When saving an intermediate file (.hc or .s) away, we
2516 have to prefix any OPTIONS found in the original source file.
2519 sub saveIntermediate {
2520 local ($final,$suffix,$tmp)= @_ ;
2523 # $final -- root of where to park ${final}.${suffix}
2524 # $tmp -- temporary file where hsc put the intermediate file.
2526 # Delete the old file
2527 $to_do = "$Rm ${final}.${suffix}"; &run_something($to_do, "Removing old .${suffix} file");
2529 if ( $#File_options >= 0 ) { # OPTIONS found in Haskell source unit
2530 # Add OPTION comment to the top of the generated .${suffix} file
2531 open(TEMP, "> ${final}.${suffix}") || &tidy_up_and_die(1,"Can't open ${final}.${suffix}\n");
2532 print TEMP "/* OPTIONS " . join(' ',@File_options) . " */\n";
2534 print STDERR "Prepending OPTIONS: " . join(' ',@File_options) . " to ${final}.${suffix}\n" if $Verbose;
2536 $to_do = "$Cat $tmp >> ${final}.${suffix}";
2537 &run_something($to_do, "Saving copy of .${suffix} file");
2544 Command-line processor
2550 # can't use getopt(s); what we want is too complicated
2552 arg: while($_ = $Args[0]) {
2555 #---------- help -------------------------------------------------------
2556 if (/^-\?$/ || /^--?help$/) { print $LongUsage; exit $Status; }
2558 #-----------version ----------------------------------------------------
2559 /^--version$/ && do { print STDERR "${PROJECTNAME}, version ${PROJECTVERSION}, patchlevel ${PROJECTPATCHLEVEL}\n"; exit $Status; };
2561 #---------- verbosity and such -----------------------------------------
2562 /^-v$/ && do { $Verbose = '-v'; $Time = 'time'; next arg; };
2564 #---------- what phases are to be run ----------------------------------
2565 /^-recomp/ && do { $Do_recomp_chkr = 1; next arg; };
2567 /^-cpp$/ && do { $Cpp_flag_set = 1; next arg; };
2568 # change the global default:
2569 # we won't run cat; we'll run the real thing
2571 /^-C$/ && do { $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0; $HscOut = '-C=';
2573 # stop after generating C
2575 /^-noC$/ && do { $HscOut = '-N='; $ProduceHi = '-nohifile=';
2576 $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0;
2578 # leave out actual C generation (debugging) [also turns off interface gen]
2580 /^-hi$/ && do { $HiOnStdout = 1; $ProduceHi = '-hifile='; next arg; };
2581 # _do_ generate an interface; usually used as: -noC -hi
2583 /^-nohi$/ && do { $ProduceHi = '-nohifile='; next arg; };
2584 # don't generate an interface (even if generating C)
2586 /^-hi-diffs$/ && do { $HiDiff_flag = 'normal'; next arg; };
2587 /^-hi-diffs-with-usages$/ && do { $HiDiff_flag = 'usages'; next arg; };
2588 /^-no-hi-diffs$/ && do { $HiDiff_flag = ''; next arg; };
2589 # show/disable diffs if the interface file changes
2591 /^-E$/ && do { push(@CcBoth_flags, '-E');
2592 $Only_preprocess_C = 1;
2593 $Do_as = 0; $Do_lnkr = 0; next arg; };
2594 # stop after preprocessing C
2595 /^-M$/ && do { $Only_generate_deps = 1; $Do_as = 0; $Do_lnkr = 0; next arg; };
2596 # only generate dependency information.
2597 /^-S$/ && do { $Do_as = 0; $Do_lnkr = 0; next arg; };
2598 # stop after generating assembler
2600 /^-c$/ && do { $Do_lnkr = 0; next arg; };
2601 # stop after generating .o files
2603 /^-link-chk$/ && do { $LinkChk = 1; next arg; };
2604 /^-no-link-chk$/ && do { $LinkChk = 0; next arg; };
2605 # don't do consistency-checking after a link
2607 /^-tmpdir$/ && do { $Tmp_prefix = &grab_arg_arg(*Args,'-tmpdir', '');
2608 $Tmp_prefix = "$Tmp_prefix/ghc$$";
2609 $ENV{'TMPDIR'} = $Tmp_prefix; # for those who use it...
2611 # use an alternate directory for temp files
2613 #---------- redirect output --------------------------------------------
2615 # -o <file>; applies to the last phase, whatever it is
2616 # "-o -" sends it to stdout
2617 # if <file> has a directory component, that dir must already exist
2619 /^-odir$/ && do { $Specific_output_dir = &grab_arg_arg(*Args,'-odir', '');
2621 # Hack, of the worst sort: don't do validation of
2622 # odir argument if you're using -M (dependency generation).
2624 if ( ! $Only_generate_deps && ! -d $Specific_output_dir) {
2625 print STDERR "$Pgm: -odir: no such directory: $Specific_output_dir\n";
2630 /^-o$/ && do { $Specific_output_file = &grab_arg_arg(*Args,'-o', '');
2631 if ($Specific_output_file ne '-'
2632 && $Specific_output_file =~ /(.*)\/[^\/]*$/) {
2633 local($dir_part) = $1;
2634 if (! -d $dir_part) {
2635 print STDERR "$Pgm: no such directory: $dir_part\n";
2641 # NB: -isuf not documented yet (because it doesn't work yet)
2642 /^-isuf$/ && do { $Isuffix = &grab_arg_arg(*Args,'-isuf', '');
2643 if ($Isuffix =~ /\./ ) {
2644 print STDERR "$Pgm: -isuf suffix shouldn't contain a .\n";
2649 /^-osuf$/ && do { $Osuffix = &grab_arg_arg(*Args,'-osuf', '');
2650 if ($Osuffix =~ /\./ ) {
2651 print STDERR "$Pgm: -osuf suffix shouldn't contain a .\n";
2656 # -ohi <file>; send the interface to <file>; "-ohi -" to send to stdout
2657 /^-ohi$/ && do { $Specific_hi_file = &grab_arg_arg(*Args,'-ohi', '');
2658 if ($Specific_hi_file ne '-'
2659 && $Specific_hi_file =~ /(.*)\/[^\/]*$/) {
2660 local($dir_part) = $1;
2661 if (! -d $dir_part) {
2662 print STDERR "$Pgm: no such directory: $dir_part\n";
2668 # The suffix to use when looking for interface files
2669 /^-hisuf$/ && do { $HiSuffix = &grab_arg_arg(*Args,'-hisuf', '');
2670 if ($HiSuffix =~ /\./ ) {
2671 print STDERR "$Pgm: -hisuf suffix shouldn't contain a .\n";
2675 # ToDo: remove, not a `normal' user thing to do (should be automatic)
2676 /^-hisuf-prelude$/ && do { $HiSuffix_prelude = &grab_arg_arg(*Args,'-hisuf-prelude', '');
2677 if ($HiSuffix =~ /\./ ) {
2678 print STDERR "$Pgm: -hisuf-prelude suffix shouldn't contain a .\n";
2682 /^-odump$/ && do { $Specific_dump_file = &grab_arg_arg(*Args,'-odump', '');
2683 if ($Specific_dump_file =~ /(.*)\/[^\/]*$/) {
2684 local($dir_part) = $1;
2685 if (! -d $dir_part) {
2686 print STDERR "$Pgm: no such directory: $dir_part\n";
2692 #-------------- scc & Profiling Stuff ----------------------------------
2694 /^-prof$/ && do { $PROFing = 'p'; next arg; }; # profiling -- details later!
2697 # generate auto SCCs on top level bindings
2698 # -auto-all = all top level bindings
2699 # -auto = only top level exported bindings
2700 $PROFauto = ( /-all/ )
2701 ? '-fauto-sccs-on-all-toplevs'
2702 : '-fauto-sccs-on-exported-toplevs';
2705 /^-caf-all/ && do { # generate individual CAF SCC annotations
2706 $PROFcaf = '-fauto-sccs-on-individual-cafs';
2709 /^-ignore-scc$/ && do {
2710 # forces ignore of scc annotations even if profiling
2711 $PROFignore_scc = '-W';
2714 /^-G(.*)$/ && do { push(@HsC_flags, "-G=$1"); # set group for cost centres
2717 /^-unprof-scc-auto/ && do {
2718 # generate auto SCCs on top level bindings when not profiling.
2719 # Used to measure optimisation effects of presence of sccs.
2720 $UNPROFscc_auto = ( /-all/ )
2721 ? '-fauto-sccs-on-all-toplevs'
2722 : '-fauto-sccs-on-exported-toplevs';
2725 #--------- ticky/concurrent/parallel -----------------------------------
2726 # we sort out the details a bit later on
2728 /^-concurrent$/ && do { $CONCURing = 'c'; next arg; }; # concurrent Haskell
2729 /^-gransim$/ && do { $GRANing = 'g'; next arg; }; # GranSim
2730 /^-ticky$/ && do { $TICKYing = 't'; next arg; }; # ticky-ticky
2731 /^-parallel$/ && do { $PARing = 'p'; next arg; }; # parallel Haskell
2733 #-------------- "user ways" --------------------------------------------
2735 (/^-user-setup-([a-oA-Z])$/ ) &&
2737 /^-user-setup-([a-oA-Z])$/ && do { $BuildTag = "_$1"; };
2739 local($stuff) = $UserSetupOpts{$BuildTag};
2740 local(@opts) = split(/\s+/, $stuff);
2742 # feed relevant ops into the arg-processing loop (if any)
2743 unshift(@Args, @opts) if $#opts >= 0;
2747 #---------- set search paths for libraries and things ------------------
2749 # we do -i just like HBC (-i clears the list; -i<colon-separated-items>
2750 # prepends the items to the list); -I is for including C .h files.
2752 /^-i$/ && do { @Import_dir = (); # import path cleared!
2753 @SysImport_dir = ();
2754 print STDERR "WARNING: import paths cleared by `-i'\n";
2757 /^-i(.*)/ && do { local(@new_items)
2758 = split( /:/, &grab_arg_arg(*Args,'-i', $1));
2759 unshift(@Import_dir, @new_items);
2762 /^-I(.*)/ && do { push(@Include_dir, &grab_arg_arg(*Args,'-I', $1)); next arg; };
2763 /^-L(.*)/ && do { push(@UserLibrary_dir, &grab_arg_arg(*Args,'-L', $1)); next arg; };
2764 /^-l(.*)/ && do { push(@UserLibrary,'-l'.&grab_arg_arg(*Args,'-l', $1)); next arg; };
2766 /^-syslib(.*)/ && do { local($syslib) = &grab_arg_arg(*Args,'-syslib',$1);
2767 print STDERR "$Pgm: no such system library (-syslib): $syslib\n",
2768 $Status++ unless $syslib =~ /^(hbc|ghc|posix|contrib)$/;
2770 unshift(@SysImport_dir,
2772 ? "$InstSysLibDir/$syslib/imports"
2773 : "$TopPwd/hslibs/$syslib/src");
2775 if ( ${INSTALLING} ) {
2776 push(@SysLibrary_dir,
2777 ("$InstSysLibDir"));
2779 push(@SysLibrary_dir,
2780 ("$TopPwd/hslibs/$syslib"
2781 ,"$TopPwd/hslibs/$syslib/cbits"));
2784 push(@SysLibrary, "-lHS$syslib");
2785 push(@SysLibrary, "-lHS${syslib}_cbits")
2786 unless $syslib eq 'contrib'; #HACK! it has no cbits
2790 #=======================================================================
2791 # various flags that we can harmlessly send to one program or another
2792 # (we will later "reclaim" some of the compiler ones now sent to gcc)
2793 #=======================================================================
2795 #---------- this driver itself (ghc) -----------------------------------
2796 # these change what executable is run for each phase:
2797 /^-pgmL(.*)$/ && do { $Unlit = $1; next arg; };
2798 /^-pgmP(.*)$/ && do { $HsCpp = $1; next arg; };
2799 /^-pgmC(.*)$/ && do { $HsC = $1; next arg; };
2800 /^-pgmcO?(.*)$/ && do { $CcRegd = $1; next arg; }; # the O? for back compat
2801 /^-pgma(.*)$/ && do { $As = $1; next arg; };
2802 /^-pgml(.*)$/ && do { $Lnkr = $1; next arg; };
2803 /^-pgmdep(.*)$/ && do { $MkDependHS = $1; next arg; };
2805 #---------- the get-anything-through opts (all pgms) -------------------
2806 # these allow arbitrary option-strings to go to any phase:
2807 /^-optL(.*)$/ && do { push(@Unlit_flags, $1); next arg; };
2808 /^-optP(.*)$/ && do { push(@HsCpp_flags, $1); next arg; };
2809 /^-optCrts(.*)$/&& do { push(@HsC_rts_flags, $1); next arg; };
2810 /^-optC(.*)$/ && do { push(@HsC_flags, $1); next arg; };
2811 /^-optcpp(.*)$/ && do { push(@Cpp_define, $1); next arg; };
2812 /^-optc(.*)$/ && do { push(@CcBoth_flags, $1); next arg; };
2813 /^-opta(.*)$/ && do { push(@As_flags, $1); next arg; };
2814 /^-optl(.*)$/ && do { push(@Ld_flags, $1); next arg; };
2815 /^-optdep(.*)$/ && do { push(@MkDependHS_flags, $1); next arg; };
2817 #---------- Haskell C pre-processor (hscpp) ----------------------------
2818 /^-D(.*)/ && do { push(@HsCpp_flags, "'-D".&grab_arg_arg(*Args,'-D',$1)."'"); next arg; };
2819 /^-U(.*)/ && do { push(@HsCpp_flags, "'-U".&grab_arg_arg(*Args,'-U',$1)."'"); next arg; };
2821 /^-genSPECS/ && do { $Cpp_flag_set = 1;
2822 $genSPECS_flag = $_;
2825 #---------- post-Haskell "assembler"------------------------------------
2826 /^-ddump-raw-asm$/ && do { $Dump_raw_asm = 1; next arg; };
2827 /^-ddump-asm-splitting-info$/ && do { $Dump_asm_splitting_info = 1; next arg; };
2829 #---------- Haskell compiler (hsc) -------------------------------------
2831 /^-keep-hc-files?-too$/ && do { $Keep_hc_file_too = 1; next arg; };
2832 /^-keep-s-files?-too$/ && do { $Keep_s_file_too = 1; next arg; };
2834 /^-fhaskell-1\.3$/ && do { next arg; }; # a no-op right now
2836 /^-fignore-interface-pragmas$/ && do { push(@HsC_flags, $_); next arg; };
2838 /^-fno-implicit-prelude$/ && do { $NoImplicitPrelude= 1; push(@HsC_flags, $_); next arg; };
2839 # don't do stack checking using page fault `trick'.
2841 /^-fstack-check$/ && do { $StkChkByPageFaultOK = 0; next arg; };
2843 # have the compiler proper generate concurrent code,
2844 # really only used when you want to configure your own
2845 # special user compilation way. (Use -concurrent when
2846 # compiling `Concurrent Haskell' programs).
2848 # (ditto for -fgransim, fscc-profiling and -fticky-ticky)
2850 /^-fconcurrent$/ && do { push(@HsC_flags,$_); next arg; };
2851 /^-fscc-profiling$/ && do { push(@HsC_flags,$_); next arg; };
2852 /^-fticky-ticky$/ && do { push(@HsC_flags,$_); next arg; };
2853 /^-fgransim$/ && do { push(@HsC_flags,$_); next arg; };
2855 /^-user-prelude-force/ && do { # ignore if not -user-prelude
2858 /^-split-objs/ && do {
2859 if ( $TargetPlatform !~ /^(alpha|hppa1\.1|i386|m68k|mips|powerpc|rs6000|sparc)-/ ) {
2861 print STDERR "WARNING: don't know how to split objects on this platform: $TargetPlatform\n`-split-objs' option ignored\n";
2866 push(@HsC_flags, "-fglobalise-toplev-names");
2867 push(@CcBoth_flags, '-DUSE_SPLIT_MARKERS');
2869 require('ghc-split.prl')
2870 || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-split.prl!\n");
2875 && do { push(@HsC_flags, $_);
2876 push(@HsP_flags, '-N');
2878 # push(@HsC_flags, '-fshow-import-specs');
2882 /^-fspeciali[sz]e-unboxed$/
2883 && do { $Oopt_DoSpecialise = '-fspecialise';
2884 $Oopt_SpecialiseUnboxed = '-fspecialise-unboxed';
2887 && do { $Oopt_DoSpecialise = '-fspecialise'; next arg; };
2888 /^-fno-speciali[sz]e$/
2889 && do { $Oopt_DoSpecialise = ''; next arg; };
2892 # Now the foldr/build options, which are *on* by default (for -O).
2895 && do { $Oopt_FoldrBuild = 1;
2896 $Oopt_FB_Support = '-fdo-arity-expand';
2900 /^-fno-foldr-build$/
2901 && do { $Oopt_FoldrBuild = 0;
2902 $Oopt_FB_Support = '';
2905 /^-fno-foldr-build-rule$/
2906 && do { $Oopt_FoldrBuild = 0;
2909 /^-fno-enable-tech$/
2910 && do { $Oopt_FB_Support = '';
2913 /^-fno-snapback-to-append$/
2914 && do { $Oopt_FoldrBuildInline .= ' -fdo-not-fold-back-append ';
2917 # --------------- Renamer -------------
2920 /^-fno-prune-tydecls$/ && do { push(@HsC_flags, $_); next arg; };
2921 /^-fno-prune-instdecls$/ && do { push(@HsC_flags, $_); next arg; };
2925 /^-fasm-(.*)$/ && do { $HscOut = '-S='; next arg; }; # force using nativeGen
2926 /^-fvia-C$/ && do { $HscOut = '-C='; next arg; }; # force using C compiler
2930 /^(-funfolding-use-threshold)(.*)$/
2931 && do { $Oopt_UnfoldingUseThreshold = $1 . &grab_arg_arg(*Args,$1, $2);
2934 /^(-fmax-simplifier-iterations)(.*)$/
2935 && do { $Oopt_MaxSimplifierIterations = $1 . &grab_arg_arg(*Args,$1, $2);
2938 /^-fno-pedantic-bottoms$/
2939 && do { $Oopt_PedanticBottoms = ''; next arg; };
2941 /^-fdo-monad-eta-expansion$/
2942 && do { $Oopt_MonadEtaExpansion = $_; next arg; };
2944 /^-fno-let-from-(case|app|strict-let)$/ # experimental, really (WDP 95/10)
2945 && do { push(@HsC_flags, $_); next arg; };
2947 /^(-freturn-in-regs-threshold)(.*)$/
2948 && do { local($what) = $1;
2949 local($num) = &grab_arg_arg(*Args,$what, $2);
2950 if ($num < 2 || $num > 8) {
2951 die "Bad experimental flag: $_\n";
2953 $HscOut = '-C='; # force using C compiler
2954 push(@HsC_flags, "$what$num");
2955 push(@CcRegd_flags, "-D__STG_REGS_AVAIL__=$num");
2959 # --------------- Warnings etc. ------
2961 /^-f(show-import-specs)/
2962 && do { push(@HsC_flags, $_); next arg; };
2964 # for now, just -fwarn-name-shadowing
2965 /^-fwarn-(.*)$/ && do { push(@HsC_flags, $_); next arg; };
2966 /^-fno-(.*)$/ && do { push(@HsC_antiflags, "-f$1");
2967 &squashHscFlag("-f$1");
2970 # --------------- platform specific flags (for gcc mostly) ----------------
2972 /^-mlong-calls$/ && do { # for GCC for HP-PA boxes,
2973 # for 2.6.x..?, does not apply for 2.7.2
2975 unshift(@CcBoth_flags, ( $_ ));
2978 /^-m(v8|sparclite|cypress|supersparc|cpu=(cypress|supersparc))$/
2979 && do { # for GCC for SPARCs
2980 unshift(@CcBoth_flags, ( $_ ));
2983 /^-monly-([432])-regs/ && do { # for iX86 boxes only; no effect otherwise
2984 $StolenX86Regs = $1;
2987 #*************** ... and lots of debugging ones (form: -d* )
2989 # -d(no-)core-lint is done this way so it is turn-off-able.
2990 /^-dcore-lint/ && do { $CoreLint = '-dcore-lint'; next arg; };
2991 /^-dno-core-lint/ && do { $CoreLint = ''; next arg; };
2992 # Ditto for STG lint
2993 /^-dstg-lint/ && do { $StgLint = '-dstg-lint'; next arg; };
2994 /^-dno-stg-lint/ && do { $StgLint = ''; next arg; };
2996 /^-d(dump|ppr)-/ && do { push(@HsC_flags, $_); next arg; };
2997 /^-dverbose-(simpl|stg)/ && do { push(@HsC_flags, $_); next arg; };
2998 /^-dshow-passes/ && do { push(@HsC_flags, $_); next arg; };
2999 /^-dshow-rn-trace/ && do { push(@HsC_flags, $_); next arg; };
3000 /^-dsource-stats/ && do { push(@HsC_flags, $_); next arg; };
3001 /^-dsimplifier-stats/ && do { push(@HsC_flags, $_); next arg; };
3002 /^-dstg-stats/ && do { $Oopt_StgStats = $_; next arg; };
3004 #*************** ... and now all these -R* ones for its runtime system...
3006 /^-Rscale-sizes?(.*)/ && do {
3007 $Scale_sizes_by = &grab_arg_arg(*Args,'-Rscale-sizes', $1);
3010 /^(-H|-Rmax-heapsize)(.*)/ && do {
3011 local($heap_size) = &grab_arg_arg(*Args,$1, $2);
3012 if ($heap_size =~ /(\d+)[Kk]$/) {
3013 $heap_size = $1 * 1000;
3014 } elsif ($heap_size =~ /(\d+)[Mm]$/) {
3015 $heap_size = $1 * 1000 * 1000;
3016 } elsif ($heap_size =~ /(\d+)[Gg]$/) {
3017 $heap_size = $1 * 1000 * 1000 * 1000;
3019 if ($heap_size <= 0) {
3020 print STDERR "$Pgm: resetting heap-size to zero!!! $heap_size\n";
3021 $Specific_heap_size = 0;
3023 # if several heap sizes given, take the largest...
3024 } elsif ($heap_size >= $Specific_heap_size) {
3025 $Specific_heap_size = $heap_size;
3027 print STDERR "$Pgm: ignoring heap-size-setting option ($_)...not the largest seen\n";
3031 /^-(K|Rmax-(stk|stack)size)(.*)/ && do {
3033 local($stk_size) = &grab_arg_arg(*Args,'-Rmax-stksize', $3);
3034 if ($stk_size =~ /(\d+)[Kk]$/) {
3035 $stk_size = $1 * 1000;
3036 } elsif ($stk_size =~ /(\d+)[Mm]$/) {
3037 $stk_size = $1 * 1000 * 1000;
3038 } elsif ($stk_size =~ /(\d+)[Gg]$/) {
3039 $stk_size = $1 * 1000 * 1000 * 1000;
3041 if ($stk_size <= 0) {
3042 print STDERR "$Pgm: resetting stack-size to zero!!! $stk_size\n";
3043 $Specific_stk_size = 0;
3045 # if several stack sizes given, take the largest...
3046 } elsif ($stk_size >= $Specific_stk_size) {
3047 $Specific_stk_size = $stk_size;
3049 print STDERR "$Pgm: ignoring stack-size-setting option ($flag $stk_size)...not the largest seen\n";
3053 /^-Rgc-stats$/ && do { $CollectingGCstats++;
3054 # the two RTSs do this diff ways; we will try to compensate
3057 /^-Rghc-timing/ && do { $CollectGhcTimings = 1; next arg; };
3059 #---------- C high-level assembler (gcc) -------------------------------
3060 /^-(Wall|ansi|pedantic)$/ && do { push(@CcBoth_flags, $_); next arg; };
3062 # -dgcc-lint is a useful way of making GCC very fussy.
3063 # From alan@spri.levels.unisa.edu.au (Alan Modra).
3064 /^-dgcc-lint$/ && do { push(@CcBoth_flags, '-Wall -Wpointer-arith -Wbad-function-cast -Wcast-qual -Wstrict-prototypes -Wmissing-prototypes -Wmissing-declarations -Wnested-externs'); next arg; };
3065 # An alternate set, from mark@sgcs.com (Mark W. Snitily)
3066 # -Wall -Wstrict-prototypes -Wmissing-prototypes -Wcast-align -Wshadow
3068 # inject "#include <wurble>" into the compiler's C output!
3070 /^-#include(.*)/ && do {
3071 local($to_include) = &grab_arg_arg(*Args,'-#include', $1);
3072 push(@CcInjects, "#include $to_include\n");
3075 #---------- Linker (gcc, really) ---------------------------------------
3077 /^-static$/ && do { push(@Ld_flags, $_); next arg; };
3079 #---------- mixed cc and linker magic ----------------------------------
3080 # this optimisation stuff is finally sorted out later on...
3082 /^-O2-for-C$/ && do { $MinusO2ForC = 1; next arg; };
3084 /^-O[1-2]?$/ && do {
3085 local($opt_lev) = ( /^-O2$/ ) ? 2 : 1; # max 'em
3086 $OptLevel = ( $opt_lev > $OptLevel ) ? $opt_lev : $OptLevel;
3088 $HscOut = '-C=' if $OptLevel == 2; # force use of C compiler
3091 /^-Onot$/ && do { $OptLevel = 0; next arg; }; # # set it to <no opt>
3093 /^-Ofile(.*)/ && do {
3095 local($ofile) = &grab_arg_arg(*Args,'-Ofile', $1);
3096 @HsC_minusO3_flags = ();
3098 open(OFILE, "< $ofile") || die "Can't open $ofile!\n";
3101 s/\#.*//; # death to comments
3102 s/[ \t]+//g; # death to whitespace
3103 next if /^$/; # ditto, blank lines
3104 s/([()*{}])/\\$1/g; # protect shell metacharacters
3106 push(@CcBoth_flags, $1);
3108 push(@HsC_minusO3_flags, $_);
3114 /^-debug$/ && do { # all this does is mark a .hc/.o as "debugging"
3115 # in the consistency info
3119 #---------- linking .a file --------------------------------------------
3121 /^-Main(.*)/ && do {
3122 # specifies main or mainPrimIO to be linked
3126 #---------- catch unrecognized flags -----------------------------------
3129 print STDERR "$Pgm: unrecognised option: $_\n";
3135 } # end of processArgs