[1] | 1 | /** @file
|
---|
| 2 | *
|
---|
| 3 | * VBox frontends: VBoxSDL (simple frontend based on SDL):
|
---|
| 4 | * Miscellaneous helpers
|
---|
| 5 | */
|
---|
| 6 |
|
---|
| 7 | /*
|
---|
[28800] | 8 | * Copyright (C) 2006-2007 Oracle Corporation
|
---|
[1] | 9 | *
|
---|
| 10 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
---|
| 11 | * available from http://www.virtualbox.org. This file is free software;
|
---|
| 12 | * you can redistribute it and/or modify it under the terms of the GNU
|
---|
[5999] | 13 | * General Public License (GPL) as published by the Free Software
|
---|
| 14 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
---|
| 15 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
---|
| 16 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
---|
[1] | 17 | */
|
---|
| 18 |
|
---|
| 19 | #define LOG_GROUP LOG_GROUP_GUI
|
---|
| 20 | #include <VBox/err.h>
|
---|
| 21 | #include <VBox/log.h>
|
---|
[3289] | 22 | #include <iprt/asm.h>
|
---|
[1] | 23 | #include <iprt/assert.h>
|
---|
| 24 | #include <iprt/thread.h>
|
---|
| 25 | #include <iprt/semaphore.h>
|
---|
| 26 | #include "VBoxSDL.h"
|
---|
| 27 | #include "Helper.h"
|
---|
| 28 |
|
---|
[614] | 29 |
|
---|
[1] | 30 | /**
|
---|
| 31 | * Globals
|
---|
| 32 | */
|
---|
| 33 |
|
---|
| 34 |
|
---|
[967] | 35 | #ifdef USE_XPCOM_QUEUE_THREAD
|
---|
[1] | 36 |
|
---|
| 37 | /** global flag indicating that the event queue thread should terminate */
|
---|
[3289] | 38 | static bool volatile g_fTerminateXPCOMQueueThread = false;
|
---|
[1] | 39 |
|
---|
[3296] | 40 | /** How many XPCOM user events are on air. Only allow one pending event to
|
---|
| 41 | * prevent an overflow of the SDL event queue. */
|
---|
[3289] | 42 | static volatile int32_t g_s32XPCOMEventsPending;
|
---|
| 43 |
|
---|
[1] | 44 | /** Semaphore the XPCOM event thread will sleep on while it waits for the main thread to process pending requests. */
|
---|
| 45 | RTSEMEVENT g_EventSemXPCOMQueueThread = NULL;
|
---|
| 46 |
|
---|
| 47 | /**
|
---|
| 48 | * Thread method to wait for XPCOM events and notify the SDL thread.
|
---|
| 49 | *
|
---|
| 50 | * @returns Error code
|
---|
| 51 | * @param thread Thread ID
|
---|
| 52 | * @param pvUser User specific parameter, the file descriptor
|
---|
| 53 | * of the event queue socket
|
---|
| 54 | */
|
---|
| 55 | DECLCALLBACK(int) xpcomEventThread(RTTHREAD thread, void *pvUser)
|
---|
| 56 | {
|
---|
[143] | 57 | int eqFD = (intptr_t)pvUser;
|
---|
[1] | 58 | unsigned cErrors = 0;
|
---|
| 59 | int rc;
|
---|
| 60 |
|
---|
| 61 | /* Wait with the processing till the main thread needs it. */
|
---|
| 62 | RTSemEventWait(g_EventSemXPCOMQueueThread, 2500);
|
---|
| 63 |
|
---|
| 64 | do
|
---|
| 65 | {
|
---|
| 66 | fd_set fdset;
|
---|
| 67 | FD_ZERO(&fdset);
|
---|
| 68 | FD_SET(eqFD, &fdset);
|
---|
| 69 | int n = select(eqFD + 1, &fdset, NULL, NULL, NULL);
|
---|
| 70 |
|
---|
| 71 | /* are there any events to process? */
|
---|
| 72 | if ((n > 0) && !g_fTerminateXPCOMQueueThread)
|
---|
| 73 | {
|
---|
[26509] | 74 | /*
|
---|
| 75 | * Wait until all XPCOM events are processed. 1s just for sanity.
|
---|
[1] | 76 | */
|
---|
[26509] | 77 | int iWait = 1000;
|
---|
| 78 | /*
|
---|
| 79 | * Don't post an event if there is a pending XPCOM event to prevent an
|
---|
| 80 | * overflow of the SDL event queue.
|
---|
| 81 | */
|
---|
| 82 | if (g_s32XPCOMEventsPending < 1)
|
---|
| 83 | {
|
---|
[3289] | 84 | /*
|
---|
[26509] | 85 | * Post the event and wait for it to be processed. If we don't wait,
|
---|
| 86 | * we'll flood the queue on SMP systems and when the main thread is busy.
|
---|
| 87 | * In the event of a push error, we'll yield the timeslice and retry.
|
---|
| 88 | */
|
---|
[3289] | 89 | SDL_Event event = {0};
|
---|
| 90 | event.type = SDL_USEREVENT;
|
---|
| 91 | event.user.type = SDL_USER_EVENT_XPCOM_EVENTQUEUE;
|
---|
| 92 | rc = SDL_PushEvent(&event);
|
---|
| 93 | if (!rc)
|
---|
| 94 | {
|
---|
| 95 | /* success */
|
---|
| 96 | ASMAtomicIncS32(&g_s32XPCOMEventsPending);
|
---|
| 97 | cErrors = 0;
|
---|
| 98 | }
|
---|
| 99 | else
|
---|
| 100 | {
|
---|
| 101 | /* failure */
|
---|
| 102 | cErrors++;
|
---|
| 103 | if (!RTThreadYield())
|
---|
| 104 | RTThreadSleep(2);
|
---|
| 105 | iWait = (cErrors >= 10) ? RT_MIN(cErrors - 8, 50) : 0;
|
---|
| 106 | }
|
---|
[1] | 107 | }
|
---|
| 108 | else
|
---|
[3289] | 109 | Log2(("not enqueueing SDL XPCOM event (%d)\n", g_s32XPCOMEventsPending));
|
---|
| 110 |
|
---|
| 111 | if (iWait)
|
---|
| 112 | RTSemEventWait(g_EventSemXPCOMQueueThread, iWait);
|
---|
[1] | 113 | }
|
---|
| 114 | } while (!g_fTerminateXPCOMQueueThread);
|
---|
| 115 | return VINF_SUCCESS;
|
---|
| 116 | }
|
---|
| 117 |
|
---|
| 118 | /**
|
---|
| 119 | * Creates the XPCOM event thread
|
---|
| 120 | *
|
---|
| 121 | * @returns VBOX status code
|
---|
| 122 | * @param eqFD XPCOM event queue file descriptor
|
---|
| 123 | */
|
---|
| 124 | int startXPCOMEventQueueThread(int eqFD)
|
---|
| 125 | {
|
---|
| 126 | int rc = RTSemEventCreate(&g_EventSemXPCOMQueueThread);
|
---|
[13835] | 127 | if (RT_SUCCESS(rc))
|
---|
[1] | 128 | {
|
---|
| 129 | RTTHREAD Thread;
|
---|
| 130 | rc = RTThreadCreate(&Thread, xpcomEventThread, (void *)eqFD, 0, RTTHREADTYPE_MSG_PUMP, 0, "XPCOMEvent");
|
---|
| 131 | }
|
---|
| 132 | AssertRC(rc);
|
---|
| 133 | return rc;
|
---|
| 134 | }
|
---|
| 135 |
|
---|
[3296] | 136 | /**
|
---|
| 137 | * Notify the XPCOM thread that we consumed an XPCOM event.
|
---|
[3289] | 138 | */
|
---|
| 139 | void consumedXPCOMUserEvent(void)
|
---|
| 140 | {
|
---|
| 141 | ASMAtomicDecS32(&g_s32XPCOMEventsPending);
|
---|
| 142 | }
|
---|
| 143 |
|
---|
[1] | 144 | /**
|
---|
| 145 | * Signal to the XPCOM even queue thread that it should select for more events.
|
---|
| 146 | */
|
---|
| 147 | void signalXPCOMEventQueueThread(void)
|
---|
| 148 | {
|
---|
| 149 | int rc = RTSemEventSignal(g_EventSemXPCOMQueueThread);
|
---|
| 150 | AssertRC(rc);
|
---|
| 151 | }
|
---|
| 152 |
|
---|
| 153 | /**
|
---|
| 154 | * Indicates to the XPCOM thread that it should terminate now.
|
---|
| 155 | */
|
---|
| 156 | void terminateXPCOMQueueThread(void)
|
---|
| 157 | {
|
---|
| 158 | g_fTerminateXPCOMQueueThread = true;
|
---|
| 159 | if (g_EventSemXPCOMQueueThread)
|
---|
| 160 | {
|
---|
| 161 | RTSemEventSignal(g_EventSemXPCOMQueueThread);
|
---|
| 162 | RTThreadYield();
|
---|
| 163 | }
|
---|
| 164 | }
|
---|
| 165 |
|
---|
[967] | 166 | #endif /* USE_XPCOM_QUEUE_THREAD */
|
---|