Fix overflow in i440fx_init()
[qemu/lumag.git] / vnc.h
blob0d398971159fbc069e39862bd4fedf33bc9c2905
1 /*
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
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 * THE SOFTWARE.
27 #ifndef __QEMU_VNC_H
28 #define __QEMU_VNC_H
30 #include "qemu-common.h"
31 #include "qemu-queue.h"
32 #include "console.h"
33 #include "monitor.h"
34 #include "audio/audio.h"
35 #include <zlib.h>
37 #include "keymaps.h"
39 // #define _VNC_DEBUG 1
41 #ifdef _VNC_DEBUG
42 #define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
43 #else
44 #define VNC_DEBUG(fmt, ...) do { } while (0)
45 #endif
47 /*****************************************************************************
49 * Core data structures
51 *****************************************************************************/
53 typedef struct Buffer
55 size_t capacity;
56 size_t offset;
57 uint8_t *buffer;
58 } Buffer;
60 typedef struct VncState VncState;
62 typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len);
64 typedef void VncWritePixels(VncState *vs, struct PixelFormat *pf, void *data, int size);
66 typedef void VncSendHextileTile(VncState *vs,
67 int x, int y, int w, int h,
68 void *last_bg,
69 void *last_fg,
70 int *has_bg, int *has_fg);
72 #define VNC_MAX_WIDTH 2560
73 #define VNC_MAX_HEIGHT 2048
74 #define VNC_DIRTY_WORDS (VNC_MAX_WIDTH / (16 * 32))
76 #define VNC_AUTH_CHALLENGE_SIZE 16
78 typedef struct VncDisplay VncDisplay;
80 #ifdef CONFIG_VNC_TLS
81 #include "vnc-tls.h"
82 #include "vnc-auth-vencrypt.h"
83 #endif
84 #ifdef CONFIG_VNC_SASL
85 #include "vnc-auth-sasl.h"
86 #endif
88 struct VncSurface
90 uint32_t dirty[VNC_MAX_HEIGHT][VNC_DIRTY_WORDS];
91 DisplaySurface *ds;
94 struct VncDisplay
96 QTAILQ_HEAD(, VncState) clients;
97 QEMUTimer *timer;
98 int timer_interval;
99 int lsock;
100 DisplayState *ds;
101 kbd_layout_t *kbd_layout;
102 int lock_key_sync;
104 QEMUCursor *cursor;
105 int cursor_msize;
106 uint8_t *cursor_mask;
108 struct VncSurface guest; /* guest visible surface (aka ds->surface) */
109 DisplaySurface *server; /* vnc server surface */
111 char *display;
112 char *password;
113 int auth;
114 #ifdef CONFIG_VNC_TLS
115 int subauth; /* Used by VeNCrypt */
116 VncDisplayTLS tls;
117 #endif
118 #ifdef CONFIG_VNC_SASL
119 VncDisplaySASL sasl;
120 #endif
123 struct VncState
125 int csock;
127 DisplayState *ds;
128 uint32_t dirty[VNC_MAX_HEIGHT][VNC_DIRTY_WORDS];
130 VncDisplay *vd;
131 int need_update;
132 int force_update;
133 uint32_t features;
134 int absolute;
135 int last_x;
136 int last_y;
138 uint32_t vnc_encoding;
140 int major;
141 int minor;
143 char challenge[VNC_AUTH_CHALLENGE_SIZE];
144 #ifdef CONFIG_VNC_TLS
145 VncStateTLS tls;
146 #endif
147 #ifdef CONFIG_VNC_SASL
148 VncStateSASL sasl;
149 #endif
151 QObject *info;
153 Buffer output;
154 Buffer input;
155 /* current output mode information */
156 VncWritePixels *write_pixels;
157 DisplaySurface clientds;
159 CaptureVoiceOut *audio_cap;
160 struct audsettings as;
162 VncReadEvent *read_handler;
163 size_t read_handler_expect;
164 /* input */
165 uint8_t modifiers_state[256];
166 QEMUPutLEDEntry *led;
168 /* Encoding specific */
170 /* Tight */
171 uint8_t tight_quality;
172 uint8_t tight_compression;
174 /* Hextile */
175 VncSendHextileTile *send_hextile_tile;
177 /* Zlib */
178 Buffer zlib;
179 Buffer zlib_tmp;
180 z_stream zlib_stream[4];
182 Notifier mouse_mode_notifier;
184 QTAILQ_ENTRY(VncState) next;
188 /*****************************************************************************
190 * Authentication modes
192 *****************************************************************************/
194 enum {
195 VNC_AUTH_INVALID = 0,
196 VNC_AUTH_NONE = 1,
197 VNC_AUTH_VNC = 2,
198 VNC_AUTH_RA2 = 5,
199 VNC_AUTH_RA2NE = 6,
200 VNC_AUTH_TIGHT = 16,
201 VNC_AUTH_ULTRA = 17,
202 VNC_AUTH_TLS = 18, /* Supported in GTK-VNC & VINO */
203 VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */
204 VNC_AUTH_SASL = 20, /* Supported in GTK-VNC & VINO */
207 enum {
208 VNC_AUTH_VENCRYPT_PLAIN = 256,
209 VNC_AUTH_VENCRYPT_TLSNONE = 257,
210 VNC_AUTH_VENCRYPT_TLSVNC = 258,
211 VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
212 VNC_AUTH_VENCRYPT_X509NONE = 260,
213 VNC_AUTH_VENCRYPT_X509VNC = 261,
214 VNC_AUTH_VENCRYPT_X509PLAIN = 262,
215 VNC_AUTH_VENCRYPT_X509SASL = 263,
216 VNC_AUTH_VENCRYPT_TLSSASL = 264,
220 /*****************************************************************************
222 * Encoding types
224 *****************************************************************************/
226 #define VNC_ENCODING_RAW 0x00000000
227 #define VNC_ENCODING_COPYRECT 0x00000001
228 #define VNC_ENCODING_RRE 0x00000002
229 #define VNC_ENCODING_CORRE 0x00000004
230 #define VNC_ENCODING_HEXTILE 0x00000005
231 #define VNC_ENCODING_ZLIB 0x00000006
232 #define VNC_ENCODING_TIGHT 0x00000007
233 #define VNC_ENCODING_ZLIBHEX 0x00000008
234 #define VNC_ENCODING_TRLE 0x0000000f
235 #define VNC_ENCODING_ZRLE 0x00000010
236 #define VNC_ENCODING_ZYWRLE 0x00000011
237 #define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00 /* -256 */
238 #define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0 /* -32 */
239 #define VNC_ENCODING_XCURSOR 0xFFFFFF10 /* -240 */
240 #define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11 /* -239 */
241 #define VNC_ENCODING_POINTER_POS 0xFFFFFF18 /* -232 */
242 #define VNC_ENCODING_LASTRECT 0xFFFFFF20 /* -224 */
243 #define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21 /* -223 */
244 #define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF /* -257 */
245 #define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE /* -258 */
246 #define VNC_ENCODING_AUDIO 0XFFFFFEFD /* -259 */
247 #define VNC_ENCODING_WMVi 0x574D5669
249 /*****************************************************************************
251 * Other tight constants
253 *****************************************************************************/
256 * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
259 #define VNC_TIGHT_CCB_RESET_MASK (0x0f)
260 #define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4)
261 #define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4)
262 #define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4)
263 #define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4)
264 #define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4)
265 #define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
267 /*****************************************************************************
269 * Features
271 *****************************************************************************/
273 #define VNC_FEATURE_RESIZE 0
274 #define VNC_FEATURE_HEXTILE 1
275 #define VNC_FEATURE_POINTER_TYPE_CHANGE 2
276 #define VNC_FEATURE_WMVI 3
277 #define VNC_FEATURE_TIGHT 4
278 #define VNC_FEATURE_ZLIB 5
279 #define VNC_FEATURE_COPYRECT 6
280 #define VNC_FEATURE_RICH_CURSOR 7
282 #define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE)
283 #define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE)
284 #define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
285 #define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI)
286 #define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT)
287 #define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB)
288 #define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT)
289 #define VNC_FEATURE_RICH_CURSOR_MASK (1 << VNC_FEATURE_RICH_CURSOR)
292 /* Client -> Server message IDs */
293 #define VNC_MSG_CLIENT_SET_PIXEL_FORMAT 0
294 #define VNC_MSG_CLIENT_SET_ENCODINGS 2
295 #define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
296 #define VNC_MSG_CLIENT_KEY_EVENT 4
297 #define VNC_MSG_CLIENT_POINTER_EVENT 5
298 #define VNC_MSG_CLIENT_CUT_TEXT 6
299 #define VNC_MSG_CLIENT_VMWARE_0 127
300 #define VNC_MSG_CLIENT_CALL_CONTROL 249
301 #define VNC_MSG_CLIENT_XVP 250
302 #define VNC_MSG_CLIENT_SET_DESKTOP_SIZE 251
303 #define VNC_MSG_CLIENT_TIGHT 252
304 #define VNC_MSG_CLIENT_GII 253
305 #define VNC_MSG_CLIENT_VMWARE_1 254
306 #define VNC_MSG_CLIENT_QEMU 255
308 /* Server -> Client message IDs */
309 #define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE 0
310 #define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES 1
311 #define VNC_MSG_SERVER_BELL 2
312 #define VNC_MSG_SERVER_CUT_TEXT 3
313 #define VNC_MSG_SERVER_VMWARE_0 127
314 #define VNC_MSG_SERVER_CALL_CONTROL 249
315 #define VNC_MSG_SERVER_XVP 250
316 #define VNC_MSG_SERVER_TIGHT 252
317 #define VNC_MSG_SERVER_GII 253
318 #define VNC_MSG_SERVER_VMWARE_1 254
319 #define VNC_MSG_SERVER_QEMU 255
323 /* QEMU client -> server message IDs */
324 #define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT 0
325 #define VNC_MSG_CLIENT_QEMU_AUDIO 1
327 /* QEMU server -> client message IDs */
328 #define VNC_MSG_SERVER_QEMU_AUDIO 1
332 /* QEMU client -> server audio message IDs */
333 #define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE 0
334 #define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE 1
335 #define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT 2
337 /* QEMU server -> client audio message IDs */
338 #define VNC_MSG_SERVER_QEMU_AUDIO_END 0
339 #define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN 1
340 #define VNC_MSG_SERVER_QEMU_AUDIO_DATA 2
343 /*****************************************************************************
345 * Internal APIs
347 *****************************************************************************/
349 /* Event loop functions */
350 void vnc_client_read(void *opaque);
351 void vnc_client_write(void *opaque);
353 long vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
354 long vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);
356 /* Protocol I/O functions */
357 void vnc_write(VncState *vs, const void *data, size_t len);
358 void vnc_write_u32(VncState *vs, uint32_t value);
359 void vnc_write_s32(VncState *vs, int32_t value);
360 void vnc_write_u16(VncState *vs, uint16_t value);
361 void vnc_write_u8(VncState *vs, uint8_t value);
362 void vnc_flush(VncState *vs);
363 void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);
366 /* Buffer I/O functions */
367 uint8_t read_u8(uint8_t *data, size_t offset);
368 uint16_t read_u16(uint8_t *data, size_t offset);
369 int32_t read_s32(uint8_t *data, size_t offset);
370 uint32_t read_u32(uint8_t *data, size_t offset);
372 /* Protocol stage functions */
373 void vnc_client_error(VncState *vs);
374 int vnc_client_io_error(VncState *vs, int ret, int last_errno);
376 void start_client_init(VncState *vs);
377 void start_auth_vnc(VncState *vs);
379 /* Buffer management */
380 void buffer_reserve(Buffer *buffer, size_t len);
381 int buffer_empty(Buffer *buffer);
382 uint8_t *buffer_end(Buffer *buffer);
383 void buffer_reset(Buffer *buffer);
384 void buffer_append(Buffer *buffer, const void *data, size_t len);
387 /* Misc helpers */
389 char *vnc_socket_local_addr(const char *format, int fd);
390 char *vnc_socket_remote_addr(const char *format, int fd);
392 /* Framebuffer */
393 void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
394 int32_t encoding);
396 void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v);
398 /* Encodings */
399 void vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
401 void vnc_hextile_send_framebuffer_update(VncState *vs, int x,
402 int y, int w, int h);
403 void vnc_hextile_set_pixel_conversion(VncState *vs, int generic);
405 void vnc_zlib_init(VncState *vs);
406 void vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
408 #endif /* __QEMU_VNC_H */