2
* QEMU VNC display driver
4
* Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>
5
* Copyright (C) 2006 Fabrice Bellard
6
* Copyright (C) 2009 Red Hat, Inc
7
* Copyright (C) 2010 Corentin Chary <corentin.chary@gmail.com>
9
* Permission is hereby granted, free of charge, to any person obtaining a copy
10
* of this software and associated documentation files (the "Software"), to deal
11
* in the Software without restriction, including without limitation the rights
12
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13
* copies of the Software, and to permit persons to whom the Software is
14
* furnished to do so, subject to the following conditions:
16
* The above copyright notice and this permission notice shall be included in
17
* all copies or substantial portions of the Software.
19
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
22
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
31
#include "qemu_socket.h"
36
* There is three levels of locking:
37
* - jobs queue lock: for each operation on the queue (push, pop, isEmpty?)
38
* - VncDisplay global lock: mainly used for framebuffer updates to avoid
39
* screen corruption if the framebuffer is updated
40
* while the worker is doing something.
41
* - VncState::output lock: used to make sure the output buffer is not corrupted
42
* if two threads try to write on it at the same time
44
* While the VNC worker thread is working, the VncDisplay global lock is hold
45
* to avoid screen corruptions (this does not block vnc_refresh() because it
46
* uses trylock()) but the output lock is not hold because the thread work on
47
* its own output buffer.
48
* When the encoding job is done, the worker thread will hold the output lock
49
* and copy its output buffer in vs->output.
58
QTAILQ_HEAD(, VncJob) jobs;
61
typedef struct VncJobQueue VncJobQueue;
64
* We use a single global queue, but most of the functions are
65
* already reetrant, so we can easilly add more than one encoding thread
67
static VncJobQueue *queue;
69
static void vnc_lock_queue(VncJobQueue *queue)
71
qemu_mutex_lock(&queue->mutex);
74
static void vnc_unlock_queue(VncJobQueue *queue)
76
qemu_mutex_unlock(&queue->mutex);
79
VncJob *vnc_job_new(VncState *vs)
81
VncJob *job = g_malloc0(sizeof(VncJob));
84
vnc_lock_queue(queue);
85
QLIST_INIT(&job->rectangles);
86
vnc_unlock_queue(queue);
90
int vnc_job_add_rect(VncJob *job, int x, int y, int w, int h)
92
VncRectEntry *entry = g_malloc0(sizeof(VncRectEntry));
99
vnc_lock_queue(queue);
100
QLIST_INSERT_HEAD(&job->rectangles, entry, next);
101
vnc_unlock_queue(queue);
105
void vnc_job_push(VncJob *job)
107
vnc_lock_queue(queue);
108
if (queue->exit || QLIST_EMPTY(&job->rectangles)) {
111
QTAILQ_INSERT_TAIL(&queue->jobs, job, next);
112
qemu_cond_broadcast(&queue->cond);
114
vnc_unlock_queue(queue);
117
static bool vnc_has_job_locked(VncState *vs)
121
QTAILQ_FOREACH(job, &queue->jobs, next) {
122
if (job->vs == vs || !vs) {
129
bool vnc_has_job(VncState *vs)
133
vnc_lock_queue(queue);
134
ret = vnc_has_job_locked(vs);
135
vnc_unlock_queue(queue);
139
void vnc_jobs_clear(VncState *vs)
143
vnc_lock_queue(queue);
144
QTAILQ_FOREACH_SAFE(job, &queue->jobs, next, tmp) {
145
if (job->vs == vs || !vs) {
146
QTAILQ_REMOVE(&queue->jobs, job, next);
149
vnc_unlock_queue(queue);
152
void vnc_jobs_join(VncState *vs)
154
vnc_lock_queue(queue);
155
while (vnc_has_job_locked(vs)) {
156
qemu_cond_wait(&queue->cond, &queue->mutex);
158
vnc_unlock_queue(queue);
159
vnc_jobs_consume_buffer(vs);
162
void vnc_jobs_consume_buffer(VncState *vs)
167
if (vs->jobs_buffer.offset) {
168
vnc_write(vs, vs->jobs_buffer.buffer, vs->jobs_buffer.offset);
169
buffer_reset(&vs->jobs_buffer);
171
flush = vs->csock != -1 && vs->abort != true;
172
vnc_unlock_output(vs);
180
* Copy data for local use
182
static void vnc_async_encoding_start(VncState *orig, VncState *local)
184
local->vnc_encoding = orig->vnc_encoding;
185
local->features = orig->features;
186
local->ds = orig->ds;
187
local->vd = orig->vd;
188
local->lossy_rect = orig->lossy_rect;
189
local->write_pixels = orig->write_pixels;
190
local->clientds = orig->clientds;
191
local->tight = orig->tight;
192
local->zlib = orig->zlib;
193
local->hextile = orig->hextile;
194
local->zrle = orig->zrle;
195
local->output = queue->buffer;
196
local->csock = -1; /* Don't do any network work on this thread */
198
buffer_reset(&local->output);
201
static void vnc_async_encoding_end(VncState *orig, VncState *local)
203
orig->tight = local->tight;
204
orig->zlib = local->zlib;
205
orig->hextile = local->hextile;
206
orig->zrle = local->zrle;
207
orig->lossy_rect = local->lossy_rect;
209
queue->buffer = local->output;
212
static int vnc_worker_thread_loop(VncJobQueue *queue)
215
VncRectEntry *entry, *tmp;
220
vnc_lock_queue(queue);
221
while (QTAILQ_EMPTY(&queue->jobs) && !queue->exit) {
222
qemu_cond_wait(&queue->cond, &queue->mutex);
224
/* Here job can only be NULL if queue->exit is true */
225
job = QTAILQ_FIRST(&queue->jobs);
226
vnc_unlock_queue(queue);
232
vnc_lock_output(job->vs);
233
if (job->vs->csock == -1 || job->vs->abort == true) {
234
vnc_unlock_output(job->vs);
237
vnc_unlock_output(job->vs);
239
/* Make a local copy of vs and switch output buffers */
240
vnc_async_encoding_start(job->vs, &vs);
242
/* Start sending rectangles */
244
vnc_write_u8(&vs, VNC_MSG_SERVER_FRAMEBUFFER_UPDATE);
245
vnc_write_u8(&vs, 0);
246
saved_offset = vs.output.offset;
247
vnc_write_u16(&vs, 0);
249
vnc_lock_display(job->vs->vd);
250
QLIST_FOREACH_SAFE(entry, &job->rectangles, next, tmp) {
253
if (job->vs->csock == -1) {
254
vnc_unlock_display(job->vs->vd);
258
n = vnc_send_framebuffer_update(&vs, entry->rect.x, entry->rect.y,
259
entry->rect.w, entry->rect.h);
266
vnc_unlock_display(job->vs->vd);
268
/* Put n_rectangles at the beginning of the message */
269
vs.output.buffer[saved_offset] = (n_rectangles >> 8) & 0xFF;
270
vs.output.buffer[saved_offset + 1] = n_rectangles & 0xFF;
272
vnc_lock_output(job->vs);
273
if (job->vs->csock != -1) {
274
buffer_reserve(&job->vs->jobs_buffer, vs.output.offset);
275
buffer_append(&job->vs->jobs_buffer, vs.output.buffer,
277
/* Copy persistent encoding data */
278
vnc_async_encoding_end(job->vs, &vs);
280
qemu_bh_schedule(job->vs->bh);
282
vnc_unlock_output(job->vs);
285
vnc_lock_queue(queue);
286
QTAILQ_REMOVE(&queue->jobs, job, next);
287
vnc_unlock_queue(queue);
288
qemu_cond_broadcast(&queue->cond);
293
static VncJobQueue *vnc_queue_init(void)
295
VncJobQueue *queue = g_malloc0(sizeof(VncJobQueue));
297
qemu_cond_init(&queue->cond);
298
qemu_mutex_init(&queue->mutex);
299
QTAILQ_INIT(&queue->jobs);
303
static void vnc_queue_clear(VncJobQueue *q)
305
qemu_cond_destroy(&queue->cond);
306
qemu_mutex_destroy(&queue->mutex);
307
buffer_free(&queue->buffer);
309
queue = NULL; /* Unset global queue */
312
static void *vnc_worker_thread(void *arg)
314
VncJobQueue *queue = arg;
316
qemu_thread_get_self(&queue->thread);
318
while (!vnc_worker_thread_loop(queue)) ;
319
vnc_queue_clear(queue);
323
void vnc_start_worker_thread(void)
327
if (vnc_worker_thread_running())
330
q = vnc_queue_init();
331
qemu_thread_create(&q->thread, vnc_worker_thread, q, QEMU_THREAD_DETACHED);
332
queue = q; /* Set global queue */
335
bool vnc_worker_thread_running(void)
337
return queue; /* Check global queue */
340
void vnc_stop_worker_thread(void)
342
if (!vnc_worker_thread_running())
345
/* Remove all jobs and wake up the thread */
346
vnc_lock_queue(queue);
348
vnc_unlock_queue(queue);
349
vnc_jobs_clear(NULL);
350
qemu_cond_broadcast(&queue->cond);