Options related to a particular phaseReplacing the program for one or more phasesphases, changingYou may specify that a different program be used for one
of the phases of the compilation system, in place of whatever
the ghc has wired into it. For example, you
might want to try a different assembler. The following options
allow you to change the external program used for a given
compilation phase:cmdUse cmd as the literate
pre-processor.cmdUse cmd as the C
pre-processor (with only).cmdUse cmd as the C
compiler.cmdUse cmd as the LLVM
optimiser.cmdUse cmd as the LLVM
compiler.cmdUse cmd as the
splitter.cmdUse cmd as the
assembler.cmdUse cmd as the
linker.cmdUse cmd as the DLL
generator.cmdUse cmd as the
pre-processor (with only).cmdUse cmd as the
program to use for embedding manifests on Windows. Normally this
is the program windres, which is supplied with a
GHC installation. See in .cmdUse cmd as the libtool command
(when using only).Forcing options to a particular phaseforcing GHC-phase optionsOptions can be forced through to a particular compilation
phase, using the following flags:optionPass option to the
literate pre-processoroptionPass option to CPP (makes
sense only if is also on).optionPass option to the
custom pre-processor (see ).optionPass option to the C compiler.optionPass option to the LLVM optimiser.optionPass option to the LLVM compiler.optionPass option to the assembler.optionPass option to the linker.optionPass option to the DLL generator.optionPass option to
windres when embedding manifests on Windows.
See in .So, for example, to force an
option to the assembler, you would tell the driver
(the dash before the E is
required).GHC is itself a Haskell program, so if you need to pass
options directly to GHC's runtime system you can enclose them in
+RTS ... -RTS (see ).Options affecting the C pre-processorpre-processing: cppC pre-processor optionscpp, pre-processing withThe C pre-processor cpp is run
over your Haskell code only if the
option -cpp
option is given. Unless you are
building a large system with significant doses of
conditional compilation, you really shouldn't need
it.symbol=valueDefine macro symbol in the
usual way. NB: does not affect
macros passed to the C compiler
when compiling via C! For those, use the
hack… (see ).symbol Undefine macro symbol in the
usual way.dir Specify a directory in which to look for
#include files, in the usual C
way.The GHC driver pre-defines several macros when processing
Haskell source code (.hs or
.lhs files).The symbols defined by GHC are listed below. To check which
symbols are defined by your local GHC installation, the following
trick is useful:$ ghc -E -optP-dM -cpp foo.hs
$ cat foo.hspp(you need a file foo.hs, but it isn't
actually used).__GLASGOW_HASKELL____GLASGOW_HASKELL__For version
x.y.z
of GHC, the value of
__GLASGOW_HASKELL__
is the integer xyy (if
y is a single digit, then a leading zero
is added, so for example in version 6.2 of GHC,
__GLASGOW_HASKELL__==602). More
information in .With any luck,
__GLASGOW_HASKELL__
will be undefined in all other implementations that
support C-style pre-processing.(For reference: the comparable symbols for other
systems are:
__HUGS__
for Hugs,
__NHC__
for nhc98, and
__HBC__
for hbc.)NB. This macro is set when pre-processing both
Haskell source and C source, including the C source
generated from a Haskell module
(i.e. .hs, .lhs,
.c and .hc
files).__GLASGOW_HASKELL_LLVM____GLASGOW_HASKELL_LLVM__Only defined when is specified. When GHC
is using version
x.y.z
of LLVM, the value of
__GLASGOW_HASKELL_LLVM__
is the integer xy.__PARALLEL_HASKELL____PARALLEL_HASKELL__Only defined when is in
use! This symbol is defined when pre-processing Haskell
(input) and pre-processing C (GHC output).os_HOST_OS=1This define allows conditional compilation based on
the Operating System, whereos is
the name of the current Operating System
(eg. linux, mingw32
for Windows, solaris, etc.).arch_HOST_ARCH=1This define allows conditional compilation based on
the host architecture, wherearch
is the name of the current architecture
(eg. i386, x86_64,
powerpc, sparc,
etc.).CPP and string gapsA small word of warning: is not
friendly to “string gaps”.-cpp
vs string gapsstring
gaps vs -cpp. In other words, strings
such as the following:strmod = "\
\ p \
\ "don't work with ;
/usr/bin/cpp elides the backslash-newline
pairs.However, it appears that if you add a space at the end
of the line, then cpp (at least GNU
cpp and possibly other
cpps) leaves the backslash-space pairs
alone and the string gap works as expected.Options affecting a Haskell pre-processorpre-processing: customPre-processor optionsA custom pre-processor is run over your Haskell
source file only if the option
-F is
given.Running a custom pre-processor at compile-time is in
some settings appropriate and useful. The
option lets you run a pre-processor as
part of the overall GHC compilation pipeline, which has
the advantage over running a Haskell pre-processor
separately in that it works in interpreted mode and you
can continue to take reap the benefits of GHC's
recompilation checker.The pre-processor is run just before the Haskell
compiler proper processes the Haskell input, but after the
literate markup has been stripped away and (possibly) the
C pre-processor has washed the Haskell input.Use
to select the program to use as the preprocessor. When
invoked, the cmd pre-processor
is given at least three arguments on its command-line: the
first argument is the name of the original source file,
the second is the name of the file holding the input, and
the third is the name of the file where
cmd should write its output
to.Additional arguments to the pre-processor can be
passed in using the option. These
are fed to cmd on the command
line after the three standard input and output
arguments.
An example of a pre-processor is to convert your source files to the
input encoding that GHC expects, i.e. create a script
convert.sh containing the lines:
#!/bin/sh
( echo "{-# LINE 1 \"$2\" #-}" ; iconv -f l1 -t utf-8 $2 ) > $3and pass -F -pgmF convert.sh to GHC.
The -f l1 option tells iconv to convert your
Latin-1 file, supplied in argument $2, while
the "-t utf-8" options tell iconv to return a UTF-8 encoded file.
The result is redirected into argument $3.
The echo "{-# LINE 1 \"$2\" #-}"
just makes sure that your error positions are reported as
in the original source file.Options affecting code generationUse GHC's native code generator
rather than compiling via LLVM.
is the default.Compile via LLVMinstead
of using the native code generator. This will generally take slightly
longer than the native code generator to compile. Produced code is
generally the same speed or faster than the other two code
generators. Compiling via LLVM requires LLVM to be on the
path.Omit code generation (and all later phases)
altogether. Might be of some use if you just want to see
dumps of the intermediate compilation phases.Generate object code. This is the default outside of
GHCi, and can be used with GHCi to cause object code to be
generated in preference to bytecode.Generate byte-code instead of object-code. This is
the default in GHCi. Byte-code can currently only be used
in the interactive interpreter, not saved to disk. This
option is only useful for reversing the effect of
.Generate position-independent code (code that can be put into
shared libraries). This currently works on Linux x86 and x86-64. On
Windows, position-independent code is never used so the flag is a
no-op on that platform.When generating code, assume that entities imported from a
different package will reside in a different shared library or
binary.Note that using this option when linking causes GHC to link
against shared libraries.Options affecting linkinglinker optionsld optionsGHC has to link your code with various libraries, possibly
including: user-supplied, GHC-supplied, and system-supplied
( math library, for example).libLink in the lib library.
On Unix systems, this will be in a file called
liblib.a
or
liblib.so
which resides somewhere on the library directories path.Because of the sad state of most UNIX linkers, the
order of such options does matter. If library
foo requires library
bar, then in general
foo should
come beforebar on the
command line.There's one other gotcha to bear in mind when using
external libraries: if the library contains a
main() function, then this will be
linked in preference to GHC's own
main() function
(eg. libf2c and libl
have their own main()s). This is
because GHC's main() comes from the
HSrts library, which is normally
included after all the other
libraries on the linker's command line. To force GHC's
main() to be used in preference to any
other main()s from external libraries,
just add the option before any
other libraries on the command line.Omits the link step. This option can be used with
to avoid the automatic linking
that takes place if the program contains a Main
module.nameIf you are using a Haskell “package”
(see ), don't forget to add the
relevant option when linking the
program too: it will cause the appropriate libraries to be
linked in with the program. Forgetting the
option will likely result in
several pages of link errors.nameOn Darwin/OS X/iOS only, link in the framework name.
This option corresponds to the option for Apple's Linker.
Please note that frameworks and packages are two different things - frameworks don't
contain any haskell code. Rather, they are Apple's way of packaging shared libraries.
To link to Apple's “Carbon” API, for example, you'd use
.
On Darwin/OS X/iOS only, link all passed files into a static library suitable
for linking into an iOS (when using a cross-compiler) or Mac Xcode project. To control
the name, use the name option as usual.
The default name is liba.a.
This should nearly always be passed when compiling for iOS with a cross-compiler.
dirWhere to find user-supplied libraries…
Prepend the directory dir to
the library directories path.dirOn Darwin/OS X/iOS only, prepend the directory dir to
the framework directories path. This option corresponds to the
option for Apple's Linker ( already means something else for GHC).Tell the linker to split the single object file that
would normally be generated into multiple object files,
one per top-level Haskell function or type in the module.
This only makes sense for libraries, where it means that
executables linked against the library are smaller as they only
link against the object files that they need. However, assembling
all the sections separately is expensive, so this is slower than
compiling normally.
We use this feature for building GHC's libraries
(warning: don't use it unless you know what you're
doing!).Tell the linker to avoid shared Haskell libraries,
if possible. This is the default.This flag tells GHC to link against shared Haskell libraries.
This flag only affects the selection of dependent libraries, not
the form of the current target (see -shared).
See on how to
create them.Note that this option also has an effect on
code generation (see above).Instead of creating an executable, GHC produces a
shared object with this linker flag. Depending on the
operating system target, this might be an ELF DSO, a Windows
DLL, or a Mac OS dylib. GHC hides the operating system
details beneath this uniform flag.The flags / control whether the
resulting shared object links statically or dynamically to
Haskell package libraries given as option. Non-Haskell
libraries are linked as gcc would regularly link it on your
system, e.g. on most ELF system the linker uses the dynamic
libraries when found.Object files linked into shared objects must be
compiled with , see When creating shared objects for Haskell packages, the
shared object must be named properly, so that GHC recognizes
the shared object when linked against this package. See
shared object name mangling.
This flag selects one of a number of modes for finding shared
libraries at runtime. See for
a description of each mode.
specifying your own main function The normal rule in Haskell is that your program must supply a main
function in module Main. When testing, it is often convenient
to change which function is the "main" one, and the flag
allows you to do so. The thing can be one of:
A lower-case identifier foo. GHC assumes that the main function is Main.foo.A module name A. GHC assumes that the main function is A.main.A qualified name A.foo. GHC assumes that the main function is A.foo.
Strictly speaking, is not a link-phase flag at all; it has no effect on the link step.
The flag must be specified when compiling the module containing the specified main function (e.g. module A
in the latter two items above). It has no effect for other modules,
and hence can safely be given to ghc --make.
However, if all the modules are otherwise up to date, you may need to force
recompilation both of the module where the new "main" is, and of the
module where the "main" function used to be;
ghc is not clever
enough to figure out that they both need recompiling. You can
force recompilation by removing the object file, or by using the
flag.
linking Haskell libraries with foreign codeIn the event you want to include ghc-compiled code
as part of another (non-Haskell) program, the RTS will not
be supplying its definition of main()
at link-time, you will have to. To signal that to the
compiler when linking, use
. See also .Notice that since the command-line passed to the
linker is rather involved, you probably want to use
ghc to do the final link of your
`mixed-language' application. This is not a requirement
though, just try linking once with on
to see what options the driver passes through to the
linker.The flag can also be
used to persuade the compiler to do the link step in
mode when there is no Haskell
Main module present (normally the
compiler will not attempt linking when there is no
Main).The flags
and have no effect when
used with , because they are
implemented by changing the definition
of main that GHC generates. See
for how to get the
effect of
and when using your
own main.
Link the program with a debugging version of the
runtime system. The debugging runtime turns on numerous
assertions and sanity checks, and provides extra options
for producing debugging output at runtime (run the program
with +RTS -? to see a list).Link the program with the "threaded" version of the
runtime system. The threaded runtime system is so-called
because it manages multiple OS threads, as opposed to the
default runtime system which is purely
single-threaded.Note that you do not need
in order to use concurrency; the
single-threaded runtime supports concurrency between Haskell
threads just fine.The threaded runtime system provides the following
benefits:It enables the RTS option RTS option to be
used, which allows threads to run in
parallelparallelism
on a
multiprocessormultiprocessorSMP
or
multicoremulticore
machine. See .If a thread makes a foreign call (and the call is
not marked unsafe), then other
Haskell threads in the program will continue to run
while the foreign call is in progress.
Additionally, foreign exported
Haskell functions may be called from multiple OS
threads simultaneously. See
.
Link the program with the "eventlog" version of the
runtime system. A program linked in this way can generate
a runtime trace of events (such as thread start/stop) to a
binary file
program.eventlog,
which can then be interpreted later by various tools. See
for more information.
can be used
with . It is implied
by .
This option affects the processing of RTS control options given either
on the command line or via the GHCRTS environment variable.
There are three possibilities:
Disable all processing of RTS options.
If appears anywhere on the command
line, then the program will abort with an error message.
If the GHCRTS environment variable is
set, then the program will emit a warning message,
GHCRTS will be ignored, and the program
will run as normal.
[this is the default setting] Enable
only the "safe" RTS options: (Currently
only
and .) Any other RTS options
on the command line or in the GHCRTS
environment variable causes the program with to abort
with an error message.
, or
just
Enable all RTS option
processing, both on the command line and through
the GHCRTS environment variable.
In GHC 6.12.3 and earlier, the default was to process all
RTS options. However, since RTS options can be used to
write logging data to arbitrary files under the security
context of the running program, there is a potential
security problem. For this reason, GHC 7.0.1 and later
default to .
Note that has no effect when
used with ; see
for details.
This option allows you to set the default RTS options at link-time. For example,
sets the default heap size to 128MB.
This will always be the default heap size for this program, unless the user overrides it.
(Depending on the setting of the option, the user might
not have the ability to change RTS options at run-time, in which case
would be the only way to set
them.)
Note that has no effect when
used with ; see
for details.
On Windows, GHC normally generates a
manifestmanifest file when linking a binary. The
manifest is placed in the file
prog.exe.manifest
where prog.exe is the name of the
executable. The manifest file currently serves just one purpose:
it disables the "installer detection"installer detectionin Windows Vista that
attempts to elevate privileges for executables with certain names
(e.g. names containing "install", "setup" or "patch"). Without the
manifest file to turn off installer detection, attempting to run an
executable that Windows deems to be an installer will return a
permission error code to the invoker. Depending on the invoker,
the result might be a dialog box asking the user for elevated
permissions, or it might simply be a permission denied
error.Installer detection can be also turned off globally for the
system using the security control panel, but GHC by default
generates binaries that don't depend on the user having disabled
installer detection.The disables generation of
the manifest file. One reason to do this would be if you had
a manifest file of your own, for example.In the future, GHC might use the manifest file for more things,
such as supplying the location of dependent DLLs. also implies
, see below.The manifest file that GHC generates when linking a binary on
Windows is also embedded in the executable itself, by default.
This means that the binary can be distributed without having to
supply the manifest file too. The embedding is done by running
windreswindres; to see exactly what GHC does to embed the manifest,
use the flag. A GHC installation comes with
its own copy of windres for this reason.See also () and
().DLLs on Windows are typically linked to by linking to a corresponding
.lib or .dll.a - the so-called import library.
GHC will typically generate such a file for every DLL you create by compiling in
-shared mode. However, sometimes you don't want to pay the
disk-space cost of creating this import library, which can be substantial - it
might require as much space as the code itself, as Haskell DLLs tend to export
lots of symbols.As long as you are happy to only be able to link to the DLL using
GetProcAddress and friends, you can supply the
flag to disable the creation of the import
library entirely.On Darwin/OS X, dynamic libraries are stamped at build time with an
"install name", which is the ultimate install path of the library file.
Any libraries or executables that subsequently link against it will pick
up that path as their runtime search location for it. By default, ghc sets
the install name to the location where the library is built. This option
allows you to override it with the specified file path. (It passes
-install_name to Apple's linker.) Ignored on other
platforms.