virtio_blk: Factor virtio_blk_handle_request out
[qemu/ar7.git] / vnc.h
blob1210824b183c0d37899a36028d7417805211f066
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 "console.h"
32 #include "monitor.h"
33 #include "audio/audio.h"
34 #include <zlib.h>
36 #include "keymaps.h"
38 // #define _VNC_DEBUG 1
40 #ifdef _VNC_DEBUG
41 #define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
42 #else
43 #define VNC_DEBUG(fmt, ...) do { } while (0)
44 #endif
46 /*****************************************************************************
48 * Core data structures
50 *****************************************************************************/
52 typedef struct Buffer
54 size_t capacity;
55 size_t offset;
56 uint8_t *buffer;
57 } Buffer;
59 typedef struct VncState VncState;
61 typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len);
63 typedef void VncWritePixels(VncState *vs, void *data, int size);
65 typedef void VncSendHextileTile(VncState *vs,
66 int x, int y, int w, int h,
67 void *last_bg,
68 void *last_fg,
69 int *has_bg, int *has_fg);
71 #define VNC_MAX_WIDTH 2048
72 #define VNC_MAX_HEIGHT 2048
73 #define VNC_DIRTY_WORDS (VNC_MAX_WIDTH / (16 * 32))
75 #define VNC_AUTH_CHALLENGE_SIZE 16
77 typedef struct VncDisplay VncDisplay;
79 #ifdef CONFIG_VNC_TLS
80 #include "vnc-tls.h"
81 #include "vnc-auth-vencrypt.h"
82 #endif
83 #ifdef CONFIG_VNC_SASL
84 #include "vnc-auth-sasl.h"
85 #endif
87 struct VncSurface
89 uint32_t dirty[VNC_MAX_HEIGHT][VNC_DIRTY_WORDS];
90 DisplaySurface *ds;
93 struct VncDisplay
95 QEMUTimer *timer;
96 int timer_interval;
97 int lsock;
98 DisplayState *ds;
99 VncState *clients;
100 kbd_layout_t *kbd_layout;
102 struct VncSurface guest; /* guest visible surface (aka ds->surface) */
103 DisplaySurface *server; /* vnc server surface */
105 char *display;
106 char *password;
107 int auth;
108 #ifdef CONFIG_VNC_TLS
109 int subauth; /* Used by VeNCrypt */
110 VncDisplayTLS tls;
111 #endif
112 #ifdef CONFIG_VNC_SASL
113 VncDisplaySASL sasl;
114 #endif
117 struct VncState
119 int csock;
121 DisplayState *ds;
122 uint32_t dirty[VNC_MAX_HEIGHT][VNC_DIRTY_WORDS];
124 VncDisplay *vd;
125 int need_update;
126 int force_update;
127 uint32_t features;
128 int absolute;
129 int last_x;
130 int last_y;
132 uint32_t vnc_encoding;
133 uint8_t tight_quality;
134 uint8_t tight_compression;
136 int major;
137 int minor;
139 char challenge[VNC_AUTH_CHALLENGE_SIZE];
140 #ifdef CONFIG_VNC_TLS
141 VncStateTLS tls;
142 #endif
143 #ifdef CONFIG_VNC_SASL
144 VncStateSASL sasl;
145 #endif
147 QObject *info;
149 Buffer output;
150 Buffer input;
151 /* current output mode information */
152 VncWritePixels *write_pixels;
153 VncSendHextileTile *send_hextile_tile;
154 DisplaySurface clientds;
156 CaptureVoiceOut *audio_cap;
157 struct audsettings as;
159 VncReadEvent *read_handler;
160 size_t read_handler_expect;
161 /* input */
162 uint8_t modifiers_state[256];
164 Buffer zlib;
165 Buffer zlib_tmp;
166 z_stream zlib_stream[4];
168 VncState *next;
172 /*****************************************************************************
174 * Authentication modes
176 *****************************************************************************/
178 enum {
179 VNC_AUTH_INVALID = 0,
180 VNC_AUTH_NONE = 1,
181 VNC_AUTH_VNC = 2,
182 VNC_AUTH_RA2 = 5,
183 VNC_AUTH_RA2NE = 6,
184 VNC_AUTH_TIGHT = 16,
185 VNC_AUTH_ULTRA = 17,
186 VNC_AUTH_TLS = 18, /* Supported in GTK-VNC & VINO */
187 VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */
188 VNC_AUTH_SASL = 20, /* Supported in GTK-VNC & VINO */
191 enum {
192 VNC_AUTH_VENCRYPT_PLAIN = 256,
193 VNC_AUTH_VENCRYPT_TLSNONE = 257,
194 VNC_AUTH_VENCRYPT_TLSVNC = 258,
195 VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
196 VNC_AUTH_VENCRYPT_X509NONE = 260,
197 VNC_AUTH_VENCRYPT_X509VNC = 261,
198 VNC_AUTH_VENCRYPT_X509PLAIN = 262,
199 VNC_AUTH_VENCRYPT_X509SASL = 263,
200 VNC_AUTH_VENCRYPT_TLSSASL = 264,
204 /*****************************************************************************
206 * Encoding types
208 *****************************************************************************/
210 #define VNC_ENCODING_RAW 0x00000000
211 #define VNC_ENCODING_COPYRECT 0x00000001
212 #define VNC_ENCODING_RRE 0x00000002
213 #define VNC_ENCODING_CORRE 0x00000004
214 #define VNC_ENCODING_HEXTILE 0x00000005
215 #define VNC_ENCODING_ZLIB 0x00000006
216 #define VNC_ENCODING_TIGHT 0x00000007
217 #define VNC_ENCODING_ZLIBHEX 0x00000008
218 #define VNC_ENCODING_TRLE 0x0000000f
219 #define VNC_ENCODING_ZRLE 0x00000010
220 #define VNC_ENCODING_ZYWRLE 0x00000011
221 #define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00 /* -256 */
222 #define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0 /* -32 */
223 #define VNC_ENCODING_XCURSOR 0xFFFFFF10 /* -240 */
224 #define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11 /* -239 */
225 #define VNC_ENCODING_POINTER_POS 0xFFFFFF18 /* -232 */
226 #define VNC_ENCODING_LASTRECT 0xFFFFFF20 /* -224 */
227 #define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21 /* -223 */
228 #define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF /* -257 */
229 #define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE /* -258 */
230 #define VNC_ENCODING_AUDIO 0XFFFFFEFD /* -259 */
231 #define VNC_ENCODING_WMVi 0x574D5669
233 /*****************************************************************************
235 * Other tight constants
237 *****************************************************************************/
240 * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
243 #define VNC_TIGHT_CCB_RESET_MASK (0x0f)
244 #define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4)
245 #define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4)
246 #define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4)
247 #define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4)
248 #define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4)
249 #define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
251 /*****************************************************************************
253 * Features
255 *****************************************************************************/
257 #define VNC_FEATURE_RESIZE 0
258 #define VNC_FEATURE_HEXTILE 1
259 #define VNC_FEATURE_POINTER_TYPE_CHANGE 2
260 #define VNC_FEATURE_WMVI 3
261 #define VNC_FEATURE_TIGHT 4
262 #define VNC_FEATURE_ZLIB 5
263 #define VNC_FEATURE_COPYRECT 6
265 #define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE)
266 #define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE)
267 #define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
268 #define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI)
269 #define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT)
270 #define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB)
271 #define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT)
274 /*****************************************************************************
276 * Internal APIs
278 *****************************************************************************/
280 /* Event loop functions */
281 void vnc_client_read(void *opaque);
282 void vnc_client_write(void *opaque);
284 long vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
285 long vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);
287 /* Protocol I/O functions */
288 void vnc_write(VncState *vs, const void *data, size_t len);
289 void vnc_write_u32(VncState *vs, uint32_t value);
290 void vnc_write_s32(VncState *vs, int32_t value);
291 void vnc_write_u16(VncState *vs, uint16_t value);
292 void vnc_write_u8(VncState *vs, uint8_t value);
293 void vnc_flush(VncState *vs);
294 void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);
297 /* Buffer I/O functions */
298 uint8_t read_u8(uint8_t *data, size_t offset);
299 uint16_t read_u16(uint8_t *data, size_t offset);
300 int32_t read_s32(uint8_t *data, size_t offset);
301 uint32_t read_u32(uint8_t *data, size_t offset);
303 /* Protocol stage functions */
304 void vnc_client_error(VncState *vs);
305 int vnc_client_io_error(VncState *vs, int ret, int last_errno);
307 void start_client_init(VncState *vs);
308 void start_auth_vnc(VncState *vs);
310 /* Buffer management */
311 void buffer_reserve(Buffer *buffer, size_t len);
312 int buffer_empty(Buffer *buffer);
313 uint8_t *buffer_end(Buffer *buffer);
314 void buffer_reset(Buffer *buffer);
315 void buffer_append(Buffer *buffer, const void *data, size_t len);
318 /* Misc helpers */
320 char *vnc_socket_local_addr(const char *format, int fd);
321 char *vnc_socket_remote_addr(const char *format, int fd);
323 #endif /* __QEMU_VNC_H */