[qemu-xen staging-4.13] ui: Fix hanging up Cocoa display on macOS 10.15 (Catalina)

[patchbot@xxxxxxx]

commit 6705b9344f8d6f134f612c2e35e87cdda5aa6284
Author:     Hikaru Nishida <hikarupsp@xxxxxxxxx>
AuthorDate: Tue Oct 15 10:07:34 2019 +0900
Commit:     Michael Roth <mdroth@xxxxxxxxxxxxxxxxxx>
CommitDate: Mon Nov 4 08:19:19 2019 -0600

    ui: Fix hanging up Cocoa display on macOS 10.15 (Catalina)
    
    macOS API documentation says that before applicationDidFinishLaunching
    is called, any events will not be processed. However, some events are
    fired before it is called in macOS Catalina. This causes deadlock of
    iothread_lock in handleEvent while it will be released after the
    app_started_sem is posted.
    This patch avoids processing events before the app_started_sem is
    posted to prevent this deadlock.
    
    Buglink: https://bugs.launchpad.net/qemu/+bug/1847906
    Signed-off-by: Hikaru Nishida <hikarupsp@xxxxxxxxx>
    Message-id: 20191015010734.85229-1-hikarupsp@xxxxxxxxx
    Signed-off-by: Gerd Hoffmann <kraxel@xxxxxxxxxx>
    (cherry picked from commit dff742ad27efa474ec04accdbf422c9acfd3e30e)
    Signed-off-by: Michael Roth <mdroth@xxxxxxxxxxxxxxxxxx>
---
 ui/cocoa.m | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/ui/cocoa.m b/ui/cocoa.m
index c2984028c5..3026ead621 100644
--- a/ui/cocoa.m
+++ b/ui/cocoa.m
@@ -132,6 +132,7 @@ NSArray * supportedImageFileTypes;
 
 static QemuSemaphore display_init_sem;
 static QemuSemaphore app_started_sem;
+static bool allow_events;
 
 // Utility functions to run specified code block with iothread lock held
 typedef void (^CodeBlock)(void);
@@ -727,6 +728,16 @@ QemuCocoaView *cocoaView;
 
 - (bool) handleEvent:(NSEvent *)event
 {
+    if(!allow_events) {
+        /*
+         * Just let OSX have all events that arrive before
+         * applicationDidFinishLaunching.
+         * This avoids a deadlock on the iothread lock, which 
cocoa_display_init()
+         * will not drop until after the app_started_sem is posted. (In theory
+         * there should not be any such events, but OSX Catalina now emits 
some.)
+         */
+        return false;
+    }
     return bool_with_iothread_lock(^{
         return [self handleEventLocked:event];
     });
@@ -1154,6 +1165,7 @@ QemuCocoaView *cocoaView;
 - (void)applicationDidFinishLaunching: (NSNotification *) note
 {
     COCOA_DEBUG("QemuCocoaAppController: applicationDidFinishLaunching\n");
+    allow_events = true;
     /* Tell cocoa_display_init to proceed */
     qemu_sem_post(&app_started_sem);
 }
--
generated by git-patchbot for /home/xen/git/qemu-xen.git#staging-4.13