Add hs_thread_done() (#8124)

See documentation for details.

2 files changed, 14 insertions, 0 deletions

diff --git a/includes/HsFFI.h b/includes/HsFFI.h
index a21811efb5..ab3b3ebb23 100644
--- a/includes/HsFFI.h
+++ b/includes/HsFFI.h
@@ -150,6 +150,7 @@ extern void hs_init     (int *argc, char **argv[]);
 extern void hs_exit     (void);
 extern void hs_set_argv (int argc, char *argv[]);
 extern void hs_add_root (void (*init_root)(void));
+extern void hs_thread_done (void);
 
 extern void hs_perform_gc (void);
 
diff --git a/includes/RtsAPI.h b/includes/RtsAPI.h
index daae30b821..6e4decb8bd 100644
--- a/includes/RtsAPI.h
+++ b/includes/RtsAPI.h
@@ -223,6 +223,19 @@ void rts_checkSchedStatus (char* site, Capability *);
 
 SchedulerStatus rts_getSchedStatus (Capability *cap);
 
+/*
+ * The RTS allocates some thread-local data when you make a call into
+ * Haskell using one of the rts_eval() functions.  This data is not
+ * normally freed until hs_exit().  If you want to free it earlier
+ * than this, perhaps because the thread is about to exit, then call
+ * rts_done() from the thread.
+ *
+ * It is safe to make more rts_eval() calls after calling rts_done(),
+ * but the next one will cause allocation of the thread-local memory
+ * again.
+ */
+void rts_done (void);
+
 /* --------------------------------------------------------------------------
    Wrapper closures