[Git][ghc/ghc][master] eventlog: Fix racy flushing

[Marge Bot]

 Marge Bot pushed to branch master at Glasgow Haskell Compiler / GHC


Commits:
04750304 by Ben Gamari at 2020-05-27T00:14:33-04:00
eventlog: Fix racy flushing

Previously no attempt was made to avoid multiple threads writing their
capability-local eventlog buffers to the eventlog writer simultaneously.
This could result in multiple eventlog streams being interleaved. Fix
this by documenting that the EventLogWriter's write() and flush()
functions may be called reentrantly and fix the default writer to
protect its FILE* by a mutex.

Fixes #18210.

- - - - -


3 changed files:

- docs/users_guide/runtime_control.rst
- includes/rts/EventLogWriter.h
- rts/eventlog/EventLogWriter.c


Changes:

=====================================
docs/users_guide/runtime_control.rst
=====================================
@@ -196,11 +196,17 @@ Furthermore GHC lets you specify the way event log data (see :rts-flag:`-l
         Hands buffered event log data to your event log writer. Return true on success.
         Required for a custom :c:type:`EventLogWriter`.
 
+        Note that this function may be called by multiple threads
+        simultaneously.
+
     .. c:member:: void flushEventLog(void)
 
         Flush buffers (if any) of your custom :c:type:`EventLogWriter`. This can
         be ``NULL``.
 
+        Note that this function may be called by multiple threads
+        simultaneously.
+
     .. c:member:: void stopEventLogWriter(void)
 
         Called when event logging is about to stop. This can be ``NULL``.


=====================================
includes/rts/EventLogWriter.h
=====================================
@@ -24,9 +24,13 @@ typedef struct {
     void (* initEventLogWriter) (void);
 
     // Write a series of events returning true on success.
+    // Note that this may be called by multiple threads simultaneously.
+    // The writer is responsible for concurrency control.
     bool (* writeEventLog) (void *eventlog, size_t eventlog_size);
 
     // Flush possibly existing buffers (may be NULL)
+    // Note that this may be called by multiple threads simultaneously.
+    // The writer is responsible for concurrency control.
     void (* flushEventLog) (void);
 
     // Close an initialized EventLogOutput (may be NULL)


=====================================
rts/eventlog/EventLogWriter.c
=====================================
@@ -28,6 +28,17 @@ static pid_t event_log_pid = -1;
 // File for logging events
 static FILE *event_log_file = NULL;
 
+#if defined(THREADED_RTS)
+// Protects event_log_file
+static Mutex event_log_mutex;
+
+static void acquire_event_log_lock(void) { ACQUIRE_LOCK(&event_log_mutex); }
+static void release_event_log_lock(void) { RELEASE_LOCK(&event_log_mutex); }
+#else
+static void acquire_event_log_lock(void) {}
+static void release_event_log_lock(void) {}
+#endif
+
 static void initEventLogFileWriter(void);
 static bool writeEventLogFile(void *eventlog, size_t eventlog_size);
 static void flushEventLogFile(void);
@@ -89,6 +100,9 @@ initEventLogFileWriter(void)
     }
 
     stgFree(event_log_filename);
+#if defined(THREADED_RTS)
+    initMutex(&event_log_mutex);
+#endif
 }
 
 static bool
@@ -97,15 +111,17 @@ writeEventLogFile(void *eventlog, size_t eventlog_size)
     unsigned char *begin = eventlog;
     size_t remain = eventlog_size;
 
+    acquire_event_log_lock();
     while (remain > 0) {
         size_t written = fwrite(begin, 1, remain, event_log_file);
         if (written == 0) {
+            release_event_log_lock();
             return false;
         }
         remain -= written;
         begin += written;
     }
-
+    release_event_log_lock();
     return true;
 }
 
@@ -124,6 +140,9 @@ stopEventLogFileWriter(void)
         fclose(event_log_file);
         event_log_file = NULL;
     }
+#if defined(THREADED_RTS)
+    closeMutex(&event_log_mutex);
+#endif
 }
 
 const EventLogWriter FileEventLogWriter = {



View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/04750304deae2128a8350e28224e1f62ae949820

-- 
View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/04750304deae2128a8350e28224e1f62ae949820
You're receiving this email because of your account on gitlab.haskell.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.haskell.org/pipermail/ghc-commits/attachments/20200527/5512fe5d/attachment-0001.html>