X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=docs%2Fusers_guide%2Fphases.xml;h=d1086d8f0ac5cfff1e7ccee19c69b277135d8d3a;hb=4d8c7c976104d2e39a1183967ec0f254a0fc0a47;hp=4afd68027475f6d639f496445f6e2fc64e875bb0;hpb=3454afa0f32053cf4b06e25f93c36c0612a9d944;p=ghc-hetmet.git diff --git a/docs/users_guide/phases.xml b/docs/users_guide/phases.xml index 4afd680..d1086d8 100644 --- a/docs/users_guide/phases.xml +++ b/docs/users_guide/phases.xml @@ -49,6 +49,28 @@ + cmd + + + + Use cmd as the LLVM + optimiser. + + + + + + cmd + + + + Use cmd as the LLVM + compiler. + + + + + cmd @@ -178,6 +200,24 @@ + option + + + + Pass option to the LLVM optimiser. + + + + + option + + + + Pass option to the LLVM compiler. + + + + option @@ -214,16 +254,6 @@ - option - - - - Pass option to the - dependency generator. - - - - option @@ -329,44 +359,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__ @@ -405,55 +397,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.). - + @@ -553,31 +532,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 @@ -609,6 +563,21 @@ $ cat foo.hspp + + + + + Compile via LLVM instead of using the native code + generator. This will generally take slightly longer than the + native code generator to compile but quicker than compiling + via C. 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. + + + + + @@ -652,12 +621,10 @@ $ cat foo.hspp Generate position-independent code (code that can be put into - shared libraries). This currently works on Mac OS X; it works on - PowerPC Linux when using the native code generator (-fasm). - It is not quite ready to be used yet for x86 Linux. - On Windows, position-independent code is never used, - and on PowerPC64 Linux, position-independent code is always used, - so the flag is a no-op on those platforms. + shared libraries). This currently works on Linux x86 and x86-64 when + using the native code generator (-fasm). + On Windows, position-independent code is never used + so the flag is a no-op on that platform. @@ -669,8 +636,8 @@ $ cat foo.hspp When generating code, assume that entities imported from a different package will reside in a different shared library or binary. - Note that this option also causes GHC to use shared libraries - when linking. + Note that using this option when linking causes GHC to link + against shared libraries. @@ -736,10 +703,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. + @@ -835,8 +802,10 @@ $ cat foo.hspp - This flag switches to shared Haskell libraries for - linking. See on how to + 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 @@ -856,23 +825,36 @@ $ 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. + + + + + + + + This flag selects one of a number of modes for finding shared + libraries at runtime. See for + a description of each mode. + + + @@ -886,21 +868,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. @@ -976,23 +958,34 @@ $ cat foo.hspp machine. See . The ability to make a foreign call that does not - block all other Haskell threads. - - The ability to invoke foreign exported Haskell - functions from multiple OS threads. + block all other Haskell threads, and to invoke + foreign-exported Haskell functions from multiple OS + threads. See . + + - With , calls to foreign - functions are made using the same OS thread that created the - Haskell thread (if it was created by a call to a foreign - exported Haskell function), or an arbitrary OS thread - otherwise (if the Haskell thread was created by - forkIO). - - More details on the use of "bound threads" in the - threaded runtime can be found in the Control.Concurrent module. + + + + + + + + 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 . + @@ -1061,6 +1054,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. + + @@ -1068,7 +1101,6 @@ $ cat foo.hspp