Make language extensions their own category in the documentation
[ghc.git] / docs / users_guide / ffi-chap.rst
1 .. _ffi:
2
3 Foreign function interface (FFI)
4 ================================
5
6 .. index::
7    single: Foreign function interface
8    single: interfacing with native code
9
10 .. extension:: ForeignFunctionInterface
11     :shortdesc: Enable foreign function interface.
12
13     :since: 6.8.1
14
15     Allow use of the Haskell foreign function interface.
16
17 GHC (mostly) conforms to the Haskell Foreign Function Interface, whose
18 definition is part of the Haskell Report on
19 `http://www.haskell.org/ <http://www.haskell.org/>`__.
20
21 FFI support is enabled by default, but can be enabled or disabled
22 explicitly with the :extension:`ForeignFunctionInterface` flag.
23
24 GHC implements a number of GHC-specific extensions to the FFI Chapter of the
25 Haskell 2010 Report. These extensions are described in :ref:`ffi-ghcexts`, but
26 please note that programs using these features are not portable. Hence, these
27 features should be avoided where possible.
28
29 The FFI libraries are documented in the accompanying  library
30 documentation; see for example the :base-ref:`Foreign.` module.
31
32 GHC differences to the FFI Chapter
33 ----------------------------------
34
35 Guaranteed call safety
36 ~~~~~~~~~~~~~~~~~~~~~~
37
38 The FFI addendum stipulates that an implementation is free to implement an
39 ``unsafe`` call by performing a ``safe`` call (and therefore may run in an
40 arbitrary thread and may be subject to concurrent garbage collection). This
41 greatly constrains library authors since it implies that it is never safe to
42 pass any heap object reference to a foreign function, even if invoked with an
43 ``unsafe`` call. For instance, it is often desirable to pass an unpinned
44 ``ByteArray#``\s directly to native code to avoid making an
45 otherwise-unnecessary copy. However, this can only be done safely under
46 ``unsafe`` call semantics as otherwise the array may be moved by the garbage
47 collector in the middle of the call.
48
49 In previous releases, GHC would take advantage of the freedom afforded by the
50 Chapter by performing ``safe`` foreign calls in place of ``unsafe`` calls in
51 the bytecode interpreter. This meant that some packages which worked when
52 compiled would fail under GHCi (e.g. :ghc-ticket:`13730`).
53
54 However, since version 8.4 this is no longer the case: GHC **guarantees** that
55 garbage collection will never occur during an ``unsafe`` call, even in the
56 bytecode interpreter.
57
58
59 .. _ffi-ghcexts:
60
61 GHC extensions to the FFI Chapter
62 ---------------------------------
63
64 The FFI features that are described in this section are specific to GHC.
65 Your code will not be portable to other compilers if you use them.
66
67 Unboxed types
68 ~~~~~~~~~~~~~
69
70 The following unboxed types may be used as basic foreign types (see FFI
71 Chapter, Section 8.6): ``Int#``, ``Word#``, ``Char#``, ``Float#``,
72 ``Double#``, ``Addr#``, ``StablePtr# a``, ``MutableByteArray#``,
73 ``ForeignObj#``, and ``ByteArray#``.
74
75 .. _ffi-newtype-io:
76
77 Newtype wrapping of the IO monad
78 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
79
80 The FFI spec requires the IO monad to appear in various places, but it
81 can sometimes be convenient to wrap the IO monad in a ``newtype``, thus: ::
82
83       newtype MyIO a = MIO (IO a)
84
85 (A reason for doing so might be to prevent the programmer from calling
86 arbitrary IO procedures in some part of the program.)
87
88 The Haskell FFI already specifies that arguments and results of foreign
89 imports and exports will be automatically unwrapped if they are newtypes
90 (Section 3.2 of the FFI addendum). GHC extends the FFI by automatically
91 unwrapping any newtypes that wrap the IO monad itself. More precisely,
92 wherever the FFI specification requires an ``IO`` type, GHC will accept any
93 newtype-wrapping of an ``IO`` type. For example, these declarations are
94 OK: ::
95
96        foreign import foo :: Int -> MyIO Int
97        foreign import "dynamic" baz :: (Int -> MyIO Int) -> CInt -> MyIO Int
98
99 .. _ffi-prim:
100
101 Primitive imports
102 ~~~~~~~~~~~~~~~~~
103
104 GHC extends the FFI with an additional calling convention ``prim``,
105 e.g.: ::
106
107        foreign import prim "foo" foo :: ByteArray# -> (# Int#, Int# #)
108
109 This is used to import functions written in Cmm code that follow an
110 internal GHC calling convention. The arguments and results must be
111 unboxed types, except that an argument may be of type ``Any`` (by way of
112 ``unsafeCoerce#``) and the result type is allowed to be an unboxed tuple
113 or the type ``Any``.
114
115 This feature is not intended for use outside of the core libraries that
116 come with GHC. For more details see the
117 :ghc-wiki:`GHC developer wiki <Commentary/PrimOps>`.
118
119 .. _ffi-interruptible:
120
121 Interruptible foreign calls
122 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
123
124 .. extension:: InterruptibleFFI
125     :shortdesc: Enable interruptible FFI.
126
127     :since: 7.2.1
128
129 This concerns the interaction of foreign calls with
130 ``Control.Concurrent.throwTo``. Normally when the target of a
131 ``throwTo`` is involved in a foreign call, the exception is not raised
132 until the call returns, and in the meantime the caller is blocked. This
133 can result in unresponsiveness, which is particularly undesirable in the
134 case of user interrupt (e.g. Control-C). The default behaviour when a
135 Control-C signal is received (``SIGINT`` on Unix) is to raise the
136 ``UserInterrupt`` exception in the main thread; if the main thread is
137 blocked in a foreign call at the time, then the program will not respond
138 to the user interrupt.
139
140 The problem is that it is not possible in general to interrupt a foreign
141 call safely. However, GHC does provide a way to interrupt blocking
142 system calls which works for most system calls on both Unix and Windows.
143 When the ``InterruptibleFFI`` extension is enabled, a foreign call can
144 be annotated with ``interruptible`` instead of ``safe`` or ``unsafe``: ::
145
146     foreign import ccall interruptible
147        "sleep" sleepBlock :: CUint -> IO CUint
148
149 ``interruptible`` behaves exactly as ``safe``, except that when a
150 ``throwTo`` is directed at a thread in an interruptible foreign call, an
151 OS-specific mechanism will be used to attempt to cause the foreign call
152 to return:
153
154 Unix systems
155     The thread making the foreign call is sent a ``SIGPIPE`` signal
156     using ``pthread_kill()``. This is usually enough to cause a blocking
157     system call to return with ``EINTR`` (GHC by default installs an
158     empty signal handler for ``SIGPIPE``, to override the default
159     behaviour which is to terminate the process immediately).
160
161 Windows systems
162     [Vista and later only] The RTS calls the Win32 function
163     ``CancelSynchronousIO``, which will cause a blocking I/O operation
164     to return with the error ``ERROR_OPERATION_ABORTED``.
165
166 If the system call is successfully interrupted, it will return to
167 Haskell whereupon the exception can be raised. Be especially careful
168 when using ``interruptible`` that the caller of the foreign function is
169 prepared to deal with the consequences of the call being interrupted; on
170 Unix it is good practice to check for ``EINTR`` always, but on Windows
171 it is not typically necessary to handle ``ERROR_OPERATION_ABORTED``.
172
173 .. _ffi-capi:
174
175 The CAPI calling convention
176 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
177
178 .. extension:: CApiFFI
179     :shortdesc: Enable the CAPI calling convention.
180
181     :since: 7.10.1
182
183 The ``CApiFFI`` extension allows a calling convention of ``capi`` to be
184 used in foreign declarations, e.g. ::
185
186     foreign import capi "header.h f" f :: CInt -> IO CInt
187
188 Rather than generating code to call ``f`` according to the platform's
189 ABI, we instead call ``f`` using the C API defined in the header
190 ``header.h``. Thus ``f`` can be called even if it may be defined as a
191 CPP ``#define`` rather than a proper function.
192
193 When using ``capi``, it is also possible to import values, rather than
194 functions. For example, ::
195
196     foreign import capi "pi.h value pi" c_pi :: CDouble
197
198 will work regardless of whether ``pi`` is defined as
199
200 .. code-block:: c
201
202     const double pi = 3.14;
203
204 or with
205
206 .. code-block:: c
207
208     #define pi 3.14
209
210 In order to tell GHC the C type that a Haskell type corresponds to when
211 it is used with the CAPI, a ``CTYPE`` pragma can be used on the type
212 definition. The header which defines the type can optionally also be
213 specified. The syntax looks like: ::
214
215     data    {-# CTYPE "unistd.h" "useconds_t" #-} T = ...
216     newtype {-# CTYPE            "useconds_t" #-} T = ...
217
218 ``hs_thread_done()``
219 ~~~~~~~~~~~~~~~~~~~~
220
221 .. code-block:: c
222
223     void hs_thread_done(void);
224
225 GHC allocates a small amount of thread-local memory when a thread calls
226 a Haskell function via a ``foreign export``. This memory is not normally
227 freed until ``hs_exit()``; the memory is cached so that subsequent calls
228 into Haskell are fast. However, if your application is long-running and
229 repeatedly creates new threads that call into Haskell, you probably want
230 to arrange that this memory is freed in those threads that have finished
231 calling Haskell functions. To do this, call ``hs_thread_done()`` from
232 the thread whose memory you want to free.
233
234 Calling ``hs_thread_done()`` is entirely optional. You can call it as
235 often or as little as you like. It is safe to call it from a thread that
236 has never called any Haskell functions, or one that never will. If you
237 forget to call it, the worst that can happen is that some memory remains
238 allocated until ``hs_exit()`` is called. If you call it too often, the
239 worst that can happen is that the next call to a Haskell function incurs
240 some extra overhead.
241
242 .. _ffi-ghc:
243
244 Using the FFI with GHC
245 ----------------------
246
247 The following sections also give some hints and tips on the use of the
248 foreign function interface in GHC.
249
250 .. _foreign-export-ghc:
251
252 Using ``foreign export`` and ``foreign import ccall "wrapper"`` with GHC
253 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
254
255 .. index::
256    single: foreign export; with GHC
257
258 When GHC compiles a module (say ``M.hs``) which uses ``foreign export``
259 or ``foreign import "wrapper"``, it generates a ``M_stub.h`` for use by
260 C programs.
261
262 For a plain ``foreign export``, the file ``M_stub.h`` contains a C
263 prototype for the foreign exported function. For example, if we compile
264 the following module: ::
265
266     module Foo where
267
268     foreign export ccall foo :: Int -> IO Int
269
270     foo :: Int -> IO Int
271     foo n = return (length (f n))
272
273     f :: Int -> [Int]
274     f 0 = []
275     f n = n:(f (n-1))
276
277 Then ``Foo_stub.h`` will contain something like this:
278
279 .. code-block:: c
280
281     #include "HsFFI.h"
282     extern HsInt foo(HsInt a0);
283
284 To invoke ``foo()`` from C, just ``#include "Foo_stub.h"`` and call
285 ``foo()``.
286
287 The ``Foo_stub.h`` file can be redirected using the ``-stubdir`` option;
288 see :ref:`options-output`.
289
290 .. _using-own-main:
291
292 Using your own ``main()``
293 ^^^^^^^^^^^^^^^^^^^^^^^^^
294
295 Normally, GHC's runtime system provides a ``main()``, which arranges to
296 invoke ``Main.main`` in the Haskell program. However, you might want to
297 link some Haskell code into a program which has a main function written
298 in another language, say C. In order to do this, you have to initialize
299 the Haskell runtime system explicitly.
300
301 Let's take the example from above, and invoke it from a standalone C
302 program. Here's the C code:
303
304 .. code-block:: c
305
306     #include <stdio.h>
307     #include "HsFFI.h"
308
309     #ifdef __GLASGOW_HASKELL__
310     #include "Foo_stub.h"
311     #endif
312
313     int main(int argc, char *argv[])
314     {
315       int i;
316
317       hs_init(&argc, &argv);
318
319       for (i = 0; i < 5; i++) {
320         printf("%d\n", foo(2500));
321       }
322
323       hs_exit();
324       return 0;
325     }
326
327 We've surrounded the GHC-specific bits with
328 ``#ifdef __GLASGOW_HASKELL__``; the rest of the code should be portable
329 across Haskell implementations that support the FFI standard.
330
331 The call to ``hs_init()`` initializes GHC's runtime system. Do NOT try
332 to invoke any Haskell functions before calling ``hs_init()``: bad things
333 will undoubtedly happen.
334
335 We pass references to ``argc`` and ``argv`` to ``hs_init()`` so that it
336 can separate out any arguments for the RTS (i.e. those arguments between
337 ``+RTS...-RTS``).
338
339 After we've finished invoking our Haskell functions, we can call
340 ``hs_exit()``, which terminates the RTS.
341
342 There can be multiple calls to ``hs_init()``, but each one should be matched by
343 one (and only one) call to ``hs_exit()``. The outermost ``hs_exit()`` will
344 actually de-initialise the system.  Note that currently GHC's runtime cannot
345 reliably re-initialise after this has happened; see :ref:`infelicities-ffi`.
346
347 .. note::
348     When linking the final program, it is normally easiest to do the
349     link using GHC, although this isn't essential. If you do use GHC, then
350     don't forget the flag :ghc-flag:`-no-hs-main`, otherwise GHC
351     will try to link to the ``Main`` Haskell module.
352
353 .. note::
354     On Windows hs_init treats argv as UTF8-encoded. Passing other encodings
355     might lead to unexpected results. Passing NULL as argv is valid but can
356     lead to <unknown> showing up in error messages instead of the name of the
357     executable.
358
359 To use ``+RTS`` flags with ``hs_init()``, we have to modify the example
360 slightly. By default, GHC's RTS will only accept "safe" ``+RTS`` flags (see
361 :ref:`options-linker`), and the :ghc-flag:`-rtsopts[=⟨none|some|all⟩]`
362 link-time flag overrides this. However, :ghc-flag:`-rtsopts[=⟨none|some|all⟩]`
363 has no effect when :ghc-flag:`-no-hs-main` is in use (and the same goes for
364 :ghc-flag:`-with-rtsopts=⟨opts⟩`). To set these options we have to call a
365 GHC-specific API instead of ``hs_init()``:
366
367 .. code-block:: c
368
369     #include <stdio.h>
370     #include "HsFFI.h"
371
372     #ifdef __GLASGOW_HASKELL__
373     #include "Foo_stub.h"
374     #include "Rts.h"
375     #endif
376
377     int main(int argc, char *argv[])
378     {
379       int i;
380
381     #if __GLASGOW_HASKELL__ >= 703
382       {
383           RtsConfig conf = defaultRtsConfig;
384           conf.rts_opts_enabled = RtsOptsAll;
385           hs_init_ghc(&argc, &argv, conf);
386       }
387     #else
388       hs_init(&argc, &argv);
389     #endif
390
391       for (i = 0; i < 5; i++) {
392         printf("%d\n", foo(2500));
393       }
394
395       hs_exit();
396       return 0;
397     }
398
399 Note two changes: we included ``Rts.h``, which defines the GHC-specific
400 external RTS interface, and we called ``hs_init_ghc()`` instead of
401 ``hs_init()``, passing an argument of type ``RtsConfig``. ``RtsConfig``
402 is a struct with various fields that affect the behaviour of the runtime
403 system. Its definition is:
404
405 .. code-block:: c
406
407     typedef struct {
408         RtsOptsEnabledEnum rts_opts_enabled;
409         const char *rts_opts;
410     } RtsConfig;
411
412     extern const RtsConfig defaultRtsConfig;
413
414     typedef enum {
415         RtsOptsNone,         // +RTS causes an error
416         RtsOptsSafeOnly,     // safe RTS options allowed; others cause an error
417         RtsOptsAll           // all RTS options allowed
418       } RtsOptsEnabledEnum;
419
420 There is a default value ``defaultRtsConfig`` that should be used to
421 initialise variables of type ``RtsConfig``. More fields will undoubtedly
422 be added to ``RtsConfig`` in the future, so in order to keep your code
423 forwards-compatible it is best to initialise with ``defaultRtsConfig``
424 and then modify the required fields, as in the code sample above.
425
426 .. _ffi-library:
427
428 Making a Haskell library that can be called from foreign code
429 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
430
431 The scenario here is much like in :ref:`using-own-main`, except that the
432 aim is not to link a complete program, but to make a library from
433 Haskell code that can be deployed in the same way that you would deploy
434 a library of C code.
435
436 The main requirement here is that the runtime needs to be initialized
437 before any Haskell code can be called, so your library should provide
438 initialisation and deinitialisation entry points, implemented in C or
439 C++. For example:
440
441 .. code-block:: c
442
443     #include <stdlib.h>
444     #include "HsFFI.h"
445
446     HsBool mylib_init(void){
447       int argc = 2;
448       char *argv[] = { "+RTS", "-A32m", NULL };
449       char **pargv = argv;
450
451       // Initialize Haskell runtime
452       hs_init(&argc, &pargv);
453
454       // do any other initialization here and
455       // return false if there was a problem
456       return HS_BOOL_TRUE;
457     }
458
459     void mylib_end(void){
460       hs_exit();
461     }
462
463 The initialisation routine, ``mylib_init``, calls ``hs_init()`` as
464 normal to initialise the Haskell runtime, and the corresponding
465 deinitialisation function ``mylib_end()`` calls ``hs_exit()`` to shut
466 down the runtime.
467
468 .. _glasgow-foreign-headers:
469
470 Using header files
471 ~~~~~~~~~~~~~~~~~~
472
473 .. index::
474    single: C calls, function headers
475
476 C functions are normally declared using prototypes in a C header file.
477 Earlier versions of GHC (6.8.3 and earlier) ``#include``\ d the header
478 file in the C source file generated from the Haskell code, and the C
479 compiler could therefore check that the C function being called via the
480 FFI was being called at the right type.
481
482 GHC no longer includes external header files when compiling via C, so
483 this checking is not performed. The change was made for compatibility
484 with the :ref:`native code generator <native-code-gen>` (:ghc-flag:`-fasm`) and to
485 comply strictly with the FFI specification, which requires that FFI calls are
486 not subject to macro expansion and other CPP conversions that may be applied
487 when using C header files. This approach also simplifies the inlining of foreign
488 calls across module and package boundaries: there's no need for the header file
489 to be available when compiling an inlined version of a foreign call, so the
490 compiler is free to inline foreign calls in any context.
491
492 The ``-#include`` option is now deprecated, and the ``include-files``
493 field in a Cabal package specification is ignored.
494
495 Memory Allocation
496 ~~~~~~~~~~~~~~~~~
497
498 The FFI libraries provide several ways to allocate memory for use with
499 the FFI, and it isn't always clear which way is the best. This decision
500 may be affected by how efficient a particular kind of allocation is on a
501 given compiler/platform, so this section aims to shed some light on how
502 the different kinds of allocation perform with GHC.
503
504 ``alloca``
505     Useful for short-term allocation when the allocation is intended to
506     scope over a given ``IO`` computation. This kind of allocation is
507     commonly used when marshalling data to and from FFI functions.
508
509     In GHC, ``alloca`` is implemented using ``MutableByteArray#``, so
510     allocation and deallocation are fast: much faster than C's
511     ``malloc/free``, but not quite as fast as stack allocation in C. Use
512     ``alloca`` whenever you can.
513
514 ``mallocForeignPtr``
515     Useful for longer-term allocation which requires garbage collection.
516     If you intend to store the pointer to the memory in a foreign data
517     structure, then ``mallocForeignPtr`` is *not* a good choice,
518     however.
519
520     In GHC, ``mallocForeignPtr`` is also implemented using
521     ``MutableByteArray#``. Although the memory is pointed to by a
522     ``ForeignPtr``, there are no actual finalizers involved (unless you
523     add one with ``addForeignPtrFinalizer``), and the deallocation is
524     done using GC, so ``mallocForeignPtr`` is normally very cheap.
525
526 ``malloc/free``
527     If all else fails, then you need to resort to ``Foreign.malloc`` and
528     ``Foreign.free``. These are just wrappers around the C functions of
529     the same name, and their efficiency will depend ultimately on the
530     implementations of these functions in your platform's C library. We
531     usually find ``malloc`` and ``free`` to be significantly slower than
532     the other forms of allocation above.
533
534 ``Foreign.Marshal.Pool``
535     Pools are currently implemented using ``malloc/free``, so while they
536     might be a more convenient way to structure your memory allocation
537     than using one of the other forms of allocation, they won't be any
538     more efficient. We do plan to provide an improved-performance
539     implementation of Pools in the future, however.
540
541 .. _ffi-threads:
542
543 Multi-threading and the FFI
544 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
545
546 In order to use the FFI in a multi-threaded setting, you must use the
547 :ghc-flag:`-threaded` option (see :ref:`options-linker`).
548
549 Foreign imports and multi-threading
550 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
551
552 When you call a ``foreign import``\ ed function that is annotated as
553 ``safe`` (the default), and the program was linked using :ghc-flag:`-threaded`,
554 then the call will run concurrently with other running Haskell threads.
555 If the program was linked without :ghc-flag:`-threaded`, then the other Haskell
556 threads will be blocked until the call returns.
557
558 This means that if you need to make a foreign call to a function that
559 takes a long time or blocks indefinitely, then you should mark it
560 ``safe`` and use :ghc-flag:`-threaded`. Some library functions make such calls
561 internally; their documentation should indicate when this is the case.
562
563 If you are making foreign calls from multiple Haskell threads and using
564 :ghc-flag:`-threaded`, make sure that the foreign code you are calling is
565 thread-safe. In particularly, some GUI libraries are not thread-safe and
566 require that the caller only invokes GUI methods from a single thread.
567 If this is the case, you may need to restrict your GUI operations to a
568 single Haskell thread, and possibly also use a bound thread (see
569 :ref:`haskell-threads-and-os-threads`).
570
571 Note that foreign calls made by different Haskell threads may execute in
572 *parallel*, even when the ``+RTS -N`` flag is not being used
573 (:ref:`parallel-options`). The :rts-flag:`-N ⟨x⟩` flag controls parallel
574 execution of Haskell threads, but there may be an arbitrary number of
575 foreign calls in progress at any one time, regardless of the ``+RTS -N``
576 value.
577
578 If a call is annotated as ``interruptible`` and the program was
579 multithreaded, the call may be interrupted in the event that the Haskell
580 thread receives an exception. The mechanism by which the interrupt
581 occurs is platform dependent, but is intended to cause blocking system
582 calls to return immediately with an interrupted error code. The
583 underlying operating system thread is not to be destroyed. See
584 :ref:`ffi-interruptible` for more details.
585
586 .. _haskell-threads-and-os-threads:
587
588 The relationship between Haskell threads and OS threads
589 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
590
591 Normally there is no fixed relationship between Haskell threads and OS
592 threads. This means that when you make a foreign call, that call may
593 take place in an unspecified OS thread. Furthermore, there is no
594 guarantee that multiple calls made by one Haskell thread will be made by
595 the same OS thread.
596
597 This usually isn't a problem, and it allows the GHC runtime system to
598 make efficient use of OS thread resources. However, there are cases
599 where it is useful to have more control over which OS thread is used,
600 for example when calling foreign code that makes use of thread-local
601 state. For cases like this, we provide *bound threads*, which are
602 Haskell threads tied to a particular OS thread. For information on bound
603 threads, see the documentation for the :base-ref:`Control.Concurrent.` module.
604
605 Foreign exports and multi-threading
606 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
607
608 When the program is linked with :ghc-flag:`-threaded`, then you may invoke
609 ``foreign export``\ ed functions from multiple OS threads concurrently.
610 The runtime system must be initialised as usual by calling
611 ``hs_init()``, and this call must complete before invoking any
612 ``foreign export``\ ed functions.
613
614 .. _hs-exit:
615
616 On the use of ``hs_exit()``
617 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
618
619 ``hs_exit()`` normally causes the termination of any running Haskell
620 threads in the system, and when ``hs_exit()`` returns, there will be no
621 more Haskell threads running. The runtime will then shut down the system
622 in an orderly way, generating profiling output and statistics if
623 necessary, and freeing all the memory it owns.
624
625 It isn't always possible to terminate a Haskell thread forcibly: for
626 example, the thread might be currently executing a foreign call, and we
627 have no way to force the foreign call to complete. What's more, the
628 runtime must assume that in the worst case the Haskell code and runtime
629 are about to be removed from memory (e.g. if this is a
630 :ref:`Windows DLL <win32-dlls>`, ``hs_exit()`` is normally called before unloading
631 the DLL). So ``hs_exit()`` *must* wait until all outstanding foreign
632 calls return before it can return itself.
633
634 The upshot of this is that if you have Haskell threads that are blocked
635 in foreign calls, then ``hs_exit()`` may hang (or possibly busy-wait)
636 until the calls return. Therefore it's a good idea to make sure you
637 don't have any such threads in the system when calling ``hs_exit()``.
638 This includes any threads doing I/O, because I/O may (or may not,
639 depending on the type of I/O and the platform) be implemented using
640 blocking foreign calls.
641
642 The GHC runtime treats program exit as a special case, to avoid the need
643 to wait for blocked threads when a standalone executable exits. Since
644 the program and all its threads are about to terminate at the same time
645 that the code is removed from memory, it isn't necessary to ensure that
646 the threads have exited first.  If you want this fast and loose
647 version of ``hs_exit()``, you can call:
648
649 .. code-block:: c
650
651    void hs_exit_nowait(void);
652
653 instead.  This is particularly useful if you have foreign libraries
654 that need to call ``hs_exit()`` at program exit (perhaps via a C++
655 destructor): in this case you should use ``hs_exit_nowait()``, because
656 the thread that called ``exit()`` and is running C++ destructors is in
657 a foreign call from Haskell that will never return, so ``hs_exit()``
658 would deadlock.
659
660 .. _hs_try_putmvar:
661
662 Waking up Haskell threads from C
663 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
664
665 Sometimes we want to be able to wake up a Haskell thread from some C
666 code.  For example, when using a callback-based C API, we register a C
667 callback and then we need to wait for the callback to run.
668
669 One way to do this is to create a ``foreign export`` that will do
670 whatever needs to be done to wake up the Haskell thread - perhaps
671 ``putMVar`` - and then call this from our C callback.  There are a
672 couple of problems with this:
673
674 1. Calling a foreign export has a lot of overhead: it creates a
675    complete new Haskell thread, for example.
676 2. The call may block for a long time if a GC is in progress.  We
677    can't use this method if the C API we're calling doesn't allow
678    blocking in the callback.
679
680 For these reasons GHC provides an external API to ``tryPutMVar``,
681 ``hs_try_putmvar``, which you can use to cheaply and asynchronously
682 wake up a Haskell thread from C/C++.
683
684 .. code-block:: c
685
686   void hs_try_putmvar (int capability, HsStablePtr sp);
687
688 The C call ``hs_try_putmvar(cap, mvar)`` is equivalent to the Haskell
689 call ``tryPutMVar mvar ()``, except that it is
690
691 * non-blocking: takes a bounded, short, amount of time
692
693 * asynchronous: the actual putMVar may be performed after the call
694   returns (for example, if the RTS is currently garbage collecting).
695   That's why ``hs_try_putmvar()`` doesn't return a result to say
696   whether the put succeeded.  It is your responsibility to ensure that
697   the ``MVar`` is empty; if it is full, ``hs_try_putmvar()`` will have
698   no effect.
699
700 **Example**. Suppose we have a C/C++ function to call that will return and then
701 invoke a callback at some point in the future, passing us some data.
702 We want to wait in Haskell for the callback to be called, and retrieve
703 the data.  We can do it like this:
704
705 .. code-block:: haskell
706
707      import GHC.Conc (newStablePtrPrimMVar, PrimMVar)
708
709      makeExternalCall = mask_ $ do
710        mvar <- newEmptyMVar
711        sp <- newStablePtrPrimMVar mvar
712        fp <- mallocForeignPtr
713        withForeignPtr fp $ \presult -> do
714          cap <- threadCapability =<< myThreadId
715          scheduleCallback sp cap presult
716          takeMVar mvar `onException`
717            forkIO (do takeMVar mvar; touchForeignPtr fp)
718          peek presult
719
720      foreign import ccall "scheduleCallback"
721          scheduleCallback :: StablePtr PrimMVar
722                           -> Int
723                           -> Ptr Result
724                           -> IO ()
725
726 And inside ``scheduleCallback``, we create a callback that will in due
727 course store the result data in the ``Ptr Result``, and then call
728 ``hs_try_putmvar()``.
729
730 There are a few things to note here.
731
732 * There's a special function to create the ``StablePtr``:
733   ``newStablePtrPrimMVar``, because the RTS needs a ``StablePtr`` to
734   the primitive ``MVar#`` object, and we can't create that directly.
735   Do *not* just use ``newStablePtr`` on the ``MVar``: your program
736   will crash.
737
738 * The ``StablePtr`` is freed by ``hs_try_putmvar()``.  This is because
739   it would otherwise be difficult to arrange to free the ``StablePtr``
740   reliably: we can't free it in Haskell, because if the ``takeMVar``
741   is interrupted by an asynchronous exception, then the callback will
742   fire at a later time.  We can't free it in C, because we don't know
743   when to free it (not when ``hs_try_putmvar()`` returns, because that
744   is an async call that uses the ``StablePtr`` at some time in the
745   future).
746
747 * The ``mask_`` is to avoid asynchronous exceptions before the
748   ``scheduleCallback`` call, which would leak the ``StablePtr``.
749
750 * We find out the current capability number and pass it to C.  This is
751   passed back to ``hs_try_putmvar``, and helps the RTS to know which
752   capability it should try to perform the ``tryPutMVar`` on.  If you
753   don't care, you can pass ``-1`` for the capability to
754   ``hs_try_putmvar``, and it will pick an arbitrary one.
755
756   Picking the right capability will help avoid unnecessary context
757   switches.  Ideally you should pass the capability that the thread
758   that will be woken up last ran on, which you can find by calling
759   ``threadCapability`` in Haskell.
760
761 * If you want to also pass some data back from the C callback to
762   Haskell, this is best done by first allocating some memory in
763   Haskell to receive the data, and passing the address to C, as we did
764   in the above example.
765
766 * ``takeMVar`` can be interrupted by an asynchronous exception.  If
767   this happens, the callback in C will still run at some point in the
768   future, will still write the result, and will still call
769   ``hs_try_putmvar()``.  Therefore we have to arrange that the memory
770   for the result stays alive until the callback has run, so if an
771   exception is thrown during ``takeMVar`` we fork another thread to
772   wait for the callback and hold the memory alive using
773   ``touchForeignPtr``.
774
775 For a fully working example, see
776 ``testsuite/tests/concurrent/should_run/hs_try_putmvar001.hs`` in the
777 GHC source tree.
778
779 .. _ffi-floating-point:
780
781 Floating point and the FFI
782 ~~~~~~~~~~~~~~~~~~~~~~~~~~
783
784 .. index::
785    single: Floating point; and the FFI
786
787 The standard C99 ``fenv.h`` header provides operations for inspecting
788 and modifying the state of the floating point unit. In particular, the
789 rounding mode used by floating point operations can be changed, and the
790 exception flags can be tested.
791
792 In Haskell, floating-point operations have pure types, and the
793 evaluation order is unspecified. So strictly speaking, since the
794 ``fenv.h`` functions let you change the results of, or observe the
795 effects of floating point operations, use of ``fenv.h`` renders the
796 behaviour of floating-point operations anywhere in the program
797 undefined.
798
799 Having said that, we *can* document exactly what GHC does with respect
800 to the floating point state, so that if you really need to use
801 ``fenv.h`` then you can do so with full knowledge of the pitfalls:
802
803 -  GHC completely ignores the floating-point environment, the runtime
804    neither modifies nor reads it.
805
806 -  The floating-point environment is not saved over a normal thread
807    context-switch. So if you modify the floating-point state in one
808    thread, those changes may be visible in other threads. Furthermore,
809    testing the exception state is not reliable, because a context switch
810    may change it. If you need to modify or test the floating point state
811    and use threads, then you must use bound threads
812    (``Control.Concurrent.forkOS``), because a bound thread has its own
813    OS thread, and OS threads do save and restore the floating-point
814    state.
815
816 -  It is safe to modify the floating-point unit state temporarily during
817    a foreign call, because foreign calls are never pre-empted by GHC.
818