Some of my part of this work has been sponsored by Sauce Labs Inc.

v3 -> v4:

* Complete rework of the mechanism for handling runloop/libdispatch

events on the main thread. PV graphics now work with the SDL UI.

* Renamed 'apple-gfx-vmapple' device to 'apple-gfx-mmio'

* hw/display/apple-gfx: threading model overhaul to be more consistent,

safer, and more QEMU-idiomatic.

* display-modes property on the apple-gfx devices now uses the

native array property mechanism and works on both device variants.

* hw/vmapple/aes: Improvements to logging and error handling.

* hw/vmapple/cfg: Bug fixes around device property default values.

* hw/vmapple/{aes,cfg,virtio-blk/vmapple}: Most header code moved into

.c files, only a single vmapple.h now contains the #defines for the

vmapple machine model-specific device type names.

* hw/block/virtio-blk: New patch for replacing virtio_blk_free_request

with g_free. (Optional)

* Various smaller changes following comments in v3 code review in

apple-gfx, aes, cfg, bdif, virtio-blk-vmapple, and the vmapple

machine type itself. See patch-specific v4 change notes for details.

v4 -> v5:

* Simplified the main thread runloop mechanism. Back to setting

     qemu_main directly, but narrowing the scope of what it needs to do,

     and it can now be NULL. (Meaning run the QEMU main event loop on

     the main thread as is traditional.)

* hw/display/apple-gfx: Further improvements to the BH based job code bridging

the libdispatch & QEMU thread synchronisation impedance mismatch.

* hw/display/apple-gfx: Thread safety and object lifetime improvements.

* hw/display/apple-gfx-*: Better buffer and error handling in display mode

property setters and getters.

* hw/vmapple/aes: More consistent and safer logging/tracing

* hw/vmapple/cfg: Better error reporting on overlong property strings.

* hw/vmapple/virtio-blk: Fixed theoretically-unaligned write to config buffer.

* vmapple machine type: Moved ecam region into machine state, improved device

property setting error handling, improved ECID/UUID extraction script and

docs.

* Various smaller fixes in apple-gfx/-mmio, apple-gfx-pci, vmapple/aes,

vmapple/cfg, vmapple/virtio-blk, and vmapple machine type.

* Added SPDX license identifiers where they were missing.

v5 -> v6:

* 01/15 (main/Cocoa/runloop): Combined functions, fixed whitespace

* 02/15 (apple-gfx): Further refinement of PVG threading: reduced some callback

tasks from BHs to merely acquiring RCU read lock; replaced some libdispatch

tasks with BHs; last remaining synchronous BH now uses emphemeral

QemuSemaphore.

* 02/15 (apple-gfx): Readability improvements and other smaller tweaks

(see patch change notes for details)

* 04/15 (display modes): Replaced use of alloca() with NSMutableArray.

v6 -> v7:

* 02/15 (apple-gfx): Use g_ptr_array_find() helper function, coding style tweak

* 03/15 (apple-gfx-pci): Removed an unused function parameter

* 04/15 (apple-gfx display mode property): Simplified error handling in

property parsing.

* 10/15 (vmapple/aes): Coding style tweaks.

* 12/15 (vmapple/cfg): Changed error messages for overrun of properties with

fixed-length strings to be more useful to users than developers.

* 15/15 (vmapple machine type): Tiny error handling fix, un-inlined function

v7 -> v8:

* 02/15 (apple-gfx): Naming and type use improvements, fixes for a bug and a

leak.

* 04/15 (apple-gfx display mode property): Type use improvement

* 10/15 (vmapple/aes): Guest error logging tweaks.

* 11/15 (vmapple/bdif): Replaced uses of cpu_physical_memory_read with

dma_memory_read, and a g_free call with g_autofree.

* 12/15 (vmapple/cfg): Macro hygiene fix: consistently enclosing arguments in

parens.

* 15/15 (vmapple machine type): Use less verbose pattern for defining uuid

property.

v8 -> v9:

* 01/16 (ui & main loop): Set qemu_main to NULL for GTK UI as well.

* 02/16 (apple-gfx): Pass device pointer to graphic_console_init(), various

     non-functional changes.

* 03/16 (apple-gfx-pci): Fixup of changed common call, whitespace and comment

formatting tweaks.

* 04/16 (apple-gfx display modes): Re-ordered type definitions so we can drop

a 'struct' keyword.

* 10/16 (vmapple/aes): Replaced a use of cpu_physical_memory_write with

dma_memory_write, minor style tweak.

* 11/16 (vmapple/bdif): Replaced uses of cpu_physical_memory_write with

dma_memory_write.

* 13/16 (vmapple/virtio-blk): Correctly specify class_size for

VMAppleVirtIOBlkClass.

* 15/16 (vmapple machine type): Documentation improvements, fixed variable

name and struct field used during pvpanic device creation.

* 16/16 (NEW/RFC vmapple/virtio-blk): Proposed change to replace type hierarchy

with a variant property. This seems cleaner and less confusing than the

original approach to me, but I'm not sure if it warrants creation of a new

QAPI enum and property type definition.

v9 -> v10:

* 01/15 (ui & main loop): Added comments to qemu_main declaration and GTK.

* 02/15 (apple-gfx): Reworked the way frame rendering code is threaded to use

BHs for sections requiring BQL.

* 02/15 (apple-gfx): Fixed ./configure error on non-macOS platforms.

* 10/15 (vmapple/aes): Code style and comment improvements.

* 12/15 (vmapple/cfg): Slightly tidier error reporting for overlong property

values.

* 13/15 (vmapple/virtio-blk): Folded v9 patch 16/16 into this one, changing

the device type design to provide a single device type with a variant

     property instead of 2 different subtypes for aux and root volumes.

* 15/15 (vmapple machine type): Documentation fixup for changed virtio-blk

device type; small improvements to shell commands in documentation;

improved propagation of errors during cfg device instantiation.

v10 -> v11:

* 01/15 (ui & main loop): Simplified main.c, better comments & commit message

* 02/15 (apple-gfx): Give each PV display instance a unique serial number.

* 02 & 03/15 (apple-gfx, -pci): Formatting/style tweaks

* 15/15 (vmapple machine type): Improvements to shell code in docs

v11 -> v12:

* 01/15 (ui & main loop): More precise wording of code comments.

* 02/15 (apple-gfx): Fixed memory management regressions introduced in v10;

improved error handling; various more conmetic code adjustments

* 09/15 (GPEX): Fixed uses of deleted GPEX_NUM_IRQS constant that have been

added to QEMU since this patch was originally written.

v12 -> v13

* 15/15 (vmapple machine type): Bumped the machine type version from 9.2

to 10.0.

* All patches in the series now have been positively reviewed and received

corresponding reviewed-by tags.

create mode 100644 hw/display/apple-gfx-mmio.m

Reviewed-by: Akihiko Odaki <akihiko.odaki@daynix.com>

Tested-by: Akihiko Odaki <akihiko.odaki@daynix.com>

diff --git a/system/main.c b/system/main.c

index XXXXXXX..XXXXXXX 100644

--- a/system/main.c

+++ b/system/main.c

@@ -XXX,XX +XXX,XX @@

#include "qemu/osdep.h"

#include "qemu-main.h"

+#include "qemu/main-loop.h"

#include "sysemu/sysemu.h"

#ifdef CONFIG_SDL

+/*

+ * SDL insists on wrapping the main() function with its own implementation on

+ * some platforms; it does so via a macro that renames our main function, so

+ * <SDL.h> must be #included here even with no SDL code called from this file.

+ */

#include <SDL.h>

#endif

-int qemu_default_main(void)

+#ifdef CONFIG_DARWIN

+#include <CoreFoundation/CoreFoundation.h>

+#endif

+

+static void *qemu_default_main(void *opaque)

{

int status;

+ bql_lock();

status = qemu_main_loop();

qemu_cleanup(status);

+ bql_unlock();

- return status;

+ exit(status);

}

-int (*qemu_main)(void) = qemu_default_main;

+int (*qemu_main)(void);

+

+#ifdef CONFIG_DARWIN

+static int os_darwin_cfrunloop_main(void)

+{

+ CFRunLoopRun();

+ g_assert_not_reached();

+}

+int (*qemu_main)(void) = os_darwin_cfrunloop_main;

+#endif

int main(int argc, char **argv)

{

qemu_init(argc, argv);

- return qemu_main();

+ bql_unlock();

+ if (qemu_main) {

+ QemuThread main_loop_thread;

+ qemu_thread_create(&main_loop_thread, "qemu_main",

+ qemu_default_main, NULL, QEMU_THREAD_DETACHED);

+ return qemu_main();

+ } else {

+ qemu_default_main(NULL);

+ }

}

@@ -XXX,XX +XXX,XX @@

int height;

} QEMUScreen;

+@class QemuCocoaPasteboardTypeOwner;

+

static void cocoa_update(DisplayChangeListener *dcl,

int x, int y, int w, int h);

@@ -XXX,XX +XXX,XX @@ static void cocoa_switch(DisplayChangeListener *dcl,

static NSInteger cbchangecount = -1;

static QemuClipboardInfo *cbinfo;

static QemuEvent cbevent;

+static QemuCocoaPasteboardTypeOwner *cbowner;

// Utility functions to run specified code block with the BQL held

typedef void (^CodeBlock)(void);

@@ -XXX,XX +XXX,XX @@ - (void) dealloc

{

COCOA_DEBUG("QemuCocoaAppController: dealloc\n");

- if (cocoaView)

- [cocoaView release];

+ [cocoaView release];

+ [cbowner release];

+ cbowner = nil;

+

[super dealloc];

}

@@ -XXX,XX +XXX,XX @@ - (void)pasteboard:(NSPasteboard *)sender provideDataForType:(NSPasteboardType)t

@end

-static QemuCocoaPasteboardTypeOwner *cbowner;

-

static void cocoa_clipboard_notify(Notifier *notifier, void *data);

static void cocoa_clipboard_request(QemuClipboardInfo *info,

QemuClipboardType type);

ProcessSerialNumber psn = { 0, kCurrentProcess };

@@ -XXX,XX +XXX,XX @@ static void cocoa_display_init(DisplayState *ds, DisplayOptions *opts)

qemu_clipboard_peer_register(&cbpeer);

[pool release];

+

+ /*

+ * The Cocoa UI will run the NSApplication runloop on the main thread

+ * rather than the default Core Foundation one.

+ */

+ qemu_main = cocoa_main;

}

static QemuDisplay qemu_display_cocoa = {

diff --git a/ui/gtk.c b/ui/gtk.c

index XXXXXXX..XXXXXXX 100644

--- a/ui/gtk.c

+++ b/ui/gtk.c

@@ -XXX,XX +XXX,XX @@

#include "qemu/cutils.h"

#include "qemu/error-report.h"

#include "qemu/main-loop.h"

+#include "qemu-main.h"

#include "ui/console.h"

#include "ui/gtk.h"

@@ -XXX,XX +XXX,XX @@ static void gtk_display_init(DisplayState *ds, DisplayOptions *opts)

#ifdef CONFIG_GTK_CLIPBOARD

gd_clipboard_init(s);

#endif /* CONFIG_GTK_CLIPBOARD */

+

+ /* GTK's event polling must happen on the main thread. */

+ qemu_main = NULL;

}

static void early_gtk_display_init(DisplayOptions *opts)

diff --git a/ui/sdl2.c b/ui/sdl2.c

index XXXXXXX..XXXXXXX 100644

--- a/ui/sdl2.c

+++ b/ui/sdl2.c

@@ -XXX,XX +XXX,XX @@

#include "sysemu/sysemu.h"

#include "ui/win32-kbd-hook.h"

#include "qemu/log.h"

+#include "qemu-main.h"

static int sdl2_num_outputs;

static struct sdl2_console *sdl2_console;

@@ -XXX,XX +XXX,XX @@ static void sdl2_display_init(DisplayState *ds, DisplayOptions *o)

}

atexit(sdl_cleanup);

+

+ /* SDL's event polling (in dpy_refresh) must happen on the main thread. */

+ qemu_main = NULL;

}

static QemuDisplay qemu_display_sdl2 = {

* Cherry-pick/rebase conflict fixes, API use updates.

* Moved from hw/vmapple/ (useful outside that machine type)

* Overhaul of threading model, many thread safety improvements.

* Asynchronous rendering.

* Memory and object lifetime fixes.

* Refactoring to split generic and (vmapple) MMIO variant specific

code.

Implementation wise, most of the complexity lies in the differing threading

models of ParavirtualizedGraphics.framework, which uses libdispatch and

internal locks, versus QEMU, which heavily uses the BQL, especially during

memory-mapped device I/O. Great care has therefore been taken to prevent

deadlocks by never calling into PVG methods while holding the BQL, and

similarly never acquiring the BQL in a callback from PVG. Different strategies

have been used (libdispatch, blocking and non-blocking BHs, RCU, etc.)

depending on the specific requirements at each framework entry and exit point.

Signed-off-by: Phil Dennis-Jordan <phil@philjordan.eu>

Reviewed-by: Akihiko Odaki <akihiko.odaki@daynix.com>

Tested-by: Akihiko Odaki <akihiko.odaki@daynix.com>

---

v2:

+ *

+ * SPDX-License-Identifier: GPL-2.0-or-later

+#include "qemu/osdep.h"

+#import <ParavirtualizedGraphics/ParavirtualizedGraphics.h>

+static void raise_irq_bh(void *opaque)

+{

+ qemu_irq *irq = opaque;

+

+ qemu_irq_pulse(*irq);

+}

+

+static void *apple_gfx_mmio_map_surface_memory(uint64_t guest_physical_address,

+ uint64_t length, bool read_only)

+{

+ void *mem;

+ MemoryRegion *region = NULL;

+

+ RCU_READ_LOCK_GUARD();

+ mem = apple_gfx_host_ptr_for_gpa_range(guest_physical_address,

+ length, read_only, &region);

+ if (mem) {

+ memory_region_ref(region);

+ }

+ return mem;

+}

+

+static bool apple_gfx_mmio_unmap_surface_memory(void *ptr)

+{

+ MemoryRegion *region;

+ ram_addr_t offset = 0;

+

+ RCU_READ_LOCK_GUARD();

+ region = memory_region_from_host(ptr, &offset);

+ if (!region) {

+ qemu_log_mask(LOG_GUEST_ERROR, "%s: memory at %p to be unmapped not "

+ "found.\n",

+ __func__, ptr);

+ return false;

+ }

+

+ trace_apple_gfx_iosfc_unmap_memory_region(ptr, region);

+ memory_region_unref(region);

+ return true;

+}

+

+

+ desc.raiseInterrupt = ^(uint32_t vector) {

+ trace_apple_gfx_raise_irq(vector);

+ aio_bh_schedule_oneshot(qemu_get_aio_context(),

+ raise_irq_bh, &s->irq_gfx);

+ };

+

+/*

+ * Data structures and functions shared between variants of the macOS

+ * ParavirtualizedGraphics.framework based apple-gfx display adapter.

+ *

+ * SPDX-License-Identifier: GPL-2.0-or-later

+ */

+

+#include "qemu/osdep.h"

+#include <dispatch/dispatch.h>

+#import <ParavirtualizedGraphics/ParavirtualizedGraphics.h>

+