X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=docs%2Fusers_guide%2Fphases.xml;h=dfa10a5b11fe4dc86e8047ac0fc442a7917f6dd6;hb=6cec61d14a324285dbb8ce73d4c7215f1f8d6766;hp=2026a34f598b43ef4be14cbc6d7976e03362880e;hpb=035890658d56bc5233f73b311a1bd08c41752d33;p=ghc-hetmet.git
diff --git a/docs/users_guide/phases.xml b/docs/users_guide/phases.xml
index 2026a34..dfa10a5 100644
--- a/docs/users_guide/phases.xml
+++ b/docs/users_guide/phases.xml
@@ -49,12 +49,23 @@
- cmd
-
+ cmd
+
- Use cmd as the
- mangler.
+ Use cmd as the LLVM
+ optimiser.
+
+
+
+
+
+ cmd
+
+
+
+ Use cmd as the LLVM
+ compiler.
@@ -178,6 +189,24 @@
+ option
+
+
+
+ Pass option to the LLVM optimiser.
+
+
+
+
+ option
+
+
+
+ Pass option to the LLVM compiler.
+
+
+
+ option
@@ -319,44 +348,6 @@ $ cat foo.hspp
- __HASKELL98__
- __HASKELL98__
-
-
- If defined, this means that GHC supports the
- language defined by the Haskell 98 report.
-
-
-
-
-
- __HASKELL__=98
- __HASKELL__=98
-
-
- In GHC 4.04 and later, the
- __HASKELL__
- macro is defined as having the value
- 98.
-
-
-
-
-
- __HASKELL1__
- __HASKELL1__
-
-
- If defined to n, that
- means GHC supports the Haskell language defined in the
- Haskell report version 1.n.
- Currently 5. This macro is deprecated, and will probably
- disappear in future versions.
-
-
-
-
- __GLASGOW_HASKELL____GLASGOW_HASKELL__
@@ -395,55 +386,42 @@ $ cat foo.hspp
-
- __CONCURRENT_HASKELL__
- __CONCURRENT_HASKELL__
-
-
- This symbol is defined when pre-processing Haskell
- (input) and pre-processing C (GHC output). Since GHC from
- version 4.00 now supports concurrent haskell by default,
- this symbol is always defined.
-
-
-
-
-
+ __PARALLEL_HASKELL____PARALLEL_HASKELL__
-
- Only defined when is in
+
+ Only defined when is in
use! This symbol is defined when pre-processing Haskell
(input) and pre-processing C (GHC output).
-
+
-
+ os_HOST_OS=1
-
- This define allows conditional compilation based on
+
+ This 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=1
-
- This define allows conditional compilation based on
+
+ This define allows conditional compilation based on
the host architecture, wherearch
is the name of the current architecture
(eg. i386, x86_64,
powerpc, sparc,
etc.).
-
+
@@ -543,31 +521,6 @@ $ cat foo.hspp
-
- Options affecting the C compiler (if applicable)
-
- include-file options
- C compiler options
- GCC options
-
- If you are compiling with lots of foreign calls, you may
- need to tell the C compiler about some
- #include files. The Right Way to do this is to
- add an INCLUDE pragma to the top of your source file
- ():
-
-{-# INCLUDE <X/Xlib.h> #-}
-
- Sometimes this isn't convenient. In those cases there's an
- equivalent command-line option:
-
-% ghc -c '-#include <X/Xlib.h>' Xstuff.lhs
-
-
-
-
-
-
Options affecting code generation
@@ -579,21 +532,23 @@ $ cat foo.hspp
Use GHC's native code generator rather than
- compiling via C. This will compile faster (up to twice as
- fast), but may produce code that is slightly slower than
- compiling via C. is the default.
+ compiling via LLVM.
+ is the default.
-
-
+
+
- Compile via C instead of using the native code
- generator. This is the default on architectures for which GHC
- doesn't have a native code generator.
+ Compile via LLVM instead 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 version 2.7 or later to be on the path.
@@ -658,7 +613,7 @@ $ cat foo.hspp
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.
+ against shared libraries.
@@ -724,10 +679,10 @@ $ cat foo.hspp
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.
-
+ to avoid the automatic linking
+ that takes place if the program contains a Main
+ module.
+
@@ -824,9 +779,9 @@ $ cat foo.hspp
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
+ 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
@@ -846,20 +801,20 @@ $ cat foo.hspp
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.
+ 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
+ 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.
+ 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.
@@ -870,9 +825,9 @@ $ cat foo.hspp
- This flag selects one of a number of modes for finding shared
- libraries at runtime. See for
- a description of each mode.
+ This flag selects one of a number of modes for finding shared
+ libraries at runtime. See for
+ a description of each mode.
@@ -889,21 +844,21 @@ $ cat foo.hspp
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.
- An module name A. GHC assumes that the main function is A.main.
- An qualified name A.foo. GHC assumes that the main function is A.foo.
-
+ A lower-case identifier foo. GHC assumes that the main function is Main.foo.
+ An module name A. GHC assumes that the main function is A.main.
+ An 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.
+ 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.
@@ -989,6 +944,109 @@ $ cat foo.hspp
+
+
+
+
+
+ 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 .
+
+
+
+
+
+
+
+
+
+
+
+ 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.)
+
+
+
+
+
+
@@ -1052,6 +1110,46 @@ $ cat foo.hspp
/>).
+
+
+
+
+
+
+
+
+ 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/MacOS 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.
+
+
@@ -1059,7 +1157,6 @@ $ cat foo.hspp