Statistics
| Branch: | Revision:

root / vnc.h @ 41b4bef6

History | View | Annotate | Download (9.7 kB)

1
/*
2
 * QEMU VNC display driver
3
 *
4
 * Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>
5
 * Copyright (C) 2006 Fabrice Bellard
6
 * Copyright (C) 2009 Red Hat, Inc
7
 *
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:
14
 *
15
 * The above copyright notice and this permission notice shall be included in
16
 * all copies or substantial portions of the Software.
17
 *
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.
25
 */
26

    
27
#ifndef __QEMU_VNC_H
28
#define __QEMU_VNC_H
29

    
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>
36

    
37
#include "keymaps.h"
38

    
39
// #define _VNC_DEBUG 1
40

    
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
46

    
47
/*****************************************************************************
48
 *
49
 * Core data structures
50
 *
51
 *****************************************************************************/
52

    
53
typedef struct Buffer
54
{
55
    size_t capacity;
56
    size_t offset;
57
    uint8_t *buffer;
58
} Buffer;
59

    
60
typedef struct VncState VncState;
61

    
62
typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len);
63

    
64
typedef void VncWritePixels(VncState *vs, void *data, int size);
65

    
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);
71

    
72
#define VNC_MAX_WIDTH 2048
73
#define VNC_MAX_HEIGHT 2048
74
#define VNC_DIRTY_WORDS (VNC_MAX_WIDTH / (16 * 32))
75

    
76
#define VNC_AUTH_CHALLENGE_SIZE 16
77

    
78
typedef struct VncDisplay VncDisplay;
79

    
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
87

    
88
struct VncSurface
89
{
90
    uint32_t dirty[VNC_MAX_HEIGHT][VNC_DIRTY_WORDS];
91
    DisplaySurface *ds;
92
};
93

    
94
struct VncDisplay
95
{
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

    
103
    struct VncSurface guest;   /* guest visible surface (aka ds->surface) */
104
    DisplaySurface *server;  /* vnc server surface */
105

    
106
    char *display;
107
    char *password;
108
    int auth;
109
#ifdef CONFIG_VNC_TLS
110
    int subauth; /* Used by VeNCrypt */
111
    VncDisplayTLS tls;
112
#endif
113
#ifdef CONFIG_VNC_SASL
114
    VncDisplaySASL sasl;
115
#endif
116
};
117

    
118
struct VncState
119
{
120
    int csock;
121

    
122
    DisplayState *ds;
123
    uint32_t dirty[VNC_MAX_HEIGHT][VNC_DIRTY_WORDS];
124

    
125
    VncDisplay *vd;
126
    int need_update;
127
    int force_update;
128
    uint32_t features;
129
    int absolute;
130
    int last_x;
131
    int last_y;
132

    
133
    uint32_t vnc_encoding;
134
    uint8_t tight_quality;
135
    uint8_t tight_compression;
136

    
137
    int major;
138
    int minor;
139

    
140
    char challenge[VNC_AUTH_CHALLENGE_SIZE];
141
#ifdef CONFIG_VNC_TLS
142
    VncStateTLS tls;
143
#endif
144
#ifdef CONFIG_VNC_SASL
145
    VncStateSASL sasl;
146
#endif
147

    
148
    QObject *info;
149

    
150
    Buffer output;
151
    Buffer input;
152
    /* current output mode information */
153
    VncWritePixels *write_pixels;
154
    VncSendHextileTile *send_hextile_tile;
155
    DisplaySurface clientds;
156

    
157
    CaptureVoiceOut *audio_cap;
158
    struct audsettings as;
159

    
160
    VncReadEvent *read_handler;
161
    size_t read_handler_expect;
162
    /* input */
163
    uint8_t modifiers_state[256];
164

    
165
    Buffer zlib;
166
    Buffer zlib_tmp;
167
    z_stream zlib_stream[4];
168

    
169
    QTAILQ_ENTRY(VncState) next;
170
};
171

    
172

    
173
/*****************************************************************************
174
 *
175
 * Authentication modes
176
 *
177
 *****************************************************************************/
178

    
179
enum {
180
    VNC_AUTH_INVALID = 0,
181
    VNC_AUTH_NONE = 1,
182
    VNC_AUTH_VNC = 2,
183
    VNC_AUTH_RA2 = 5,
184
    VNC_AUTH_RA2NE = 6,
185
    VNC_AUTH_TIGHT = 16,
186
    VNC_AUTH_ULTRA = 17,
187
    VNC_AUTH_TLS = 18,      /* Supported in GTK-VNC & VINO */
188
    VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */
189
    VNC_AUTH_SASL = 20,     /* Supported in GTK-VNC & VINO */
190
};
191

    
192
enum {
193
    VNC_AUTH_VENCRYPT_PLAIN = 256,
194
    VNC_AUTH_VENCRYPT_TLSNONE = 257,
195
    VNC_AUTH_VENCRYPT_TLSVNC = 258,
196
    VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
197
    VNC_AUTH_VENCRYPT_X509NONE = 260,
198
    VNC_AUTH_VENCRYPT_X509VNC = 261,
199
    VNC_AUTH_VENCRYPT_X509PLAIN = 262,
200
    VNC_AUTH_VENCRYPT_X509SASL = 263,
201
    VNC_AUTH_VENCRYPT_TLSSASL = 264,
202
};
203

    
204

    
205
/*****************************************************************************
206
 *
207
 * Encoding types
208
 *
209
 *****************************************************************************/
210

    
211
#define VNC_ENCODING_RAW                  0x00000000
212
#define VNC_ENCODING_COPYRECT             0x00000001
213
#define VNC_ENCODING_RRE                  0x00000002
214
#define VNC_ENCODING_CORRE                0x00000004
215
#define VNC_ENCODING_HEXTILE              0x00000005
216
#define VNC_ENCODING_ZLIB                 0x00000006
217
#define VNC_ENCODING_TIGHT                0x00000007
218
#define VNC_ENCODING_ZLIBHEX              0x00000008
219
#define VNC_ENCODING_TRLE                 0x0000000f
220
#define VNC_ENCODING_ZRLE                 0x00000010
221
#define VNC_ENCODING_ZYWRLE               0x00000011
222
#define VNC_ENCODING_COMPRESSLEVEL0       0xFFFFFF00 /* -256 */
223
#define VNC_ENCODING_QUALITYLEVEL0        0xFFFFFFE0 /* -32  */
224
#define VNC_ENCODING_XCURSOR              0xFFFFFF10 /* -240 */
225
#define VNC_ENCODING_RICH_CURSOR          0xFFFFFF11 /* -239 */
226
#define VNC_ENCODING_POINTER_POS          0xFFFFFF18 /* -232 */
227
#define VNC_ENCODING_LASTRECT             0xFFFFFF20 /* -224 */
228
#define VNC_ENCODING_DESKTOPRESIZE        0xFFFFFF21 /* -223 */
229
#define VNC_ENCODING_POINTER_TYPE_CHANGE  0XFFFFFEFF /* -257 */
230
#define VNC_ENCODING_EXT_KEY_EVENT        0XFFFFFEFE /* -258 */
231
#define VNC_ENCODING_AUDIO                0XFFFFFEFD /* -259 */
232
#define VNC_ENCODING_WMVi                 0x574D5669
233

    
234
/*****************************************************************************
235
 *
236
 * Other tight constants
237
 *
238
 *****************************************************************************/
239

    
240
/*
241
 * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
242
 */
243

    
244
#define VNC_TIGHT_CCB_RESET_MASK   (0x0f)
245
#define VNC_TIGHT_CCB_TYPE_MASK    (0x0f << 4)
246
#define VNC_TIGHT_CCB_TYPE_FILL    (0x08 << 4)
247
#define VNC_TIGHT_CCB_TYPE_JPEG    (0x09 << 4)
248
#define VNC_TIGHT_CCB_BASIC_MAX    (0x07 << 4)
249
#define VNC_TIGHT_CCB_BASIC_ZLIB   (0x03 << 4)
250
#define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
251

    
252
/*****************************************************************************
253
 *
254
 * Features
255
 *
256
 *****************************************************************************/
257

    
258
#define VNC_FEATURE_RESIZE                   0
259
#define VNC_FEATURE_HEXTILE                  1
260
#define VNC_FEATURE_POINTER_TYPE_CHANGE      2
261
#define VNC_FEATURE_WMVI                     3
262
#define VNC_FEATURE_TIGHT                    4
263
#define VNC_FEATURE_ZLIB                     5
264
#define VNC_FEATURE_COPYRECT                 6
265

    
266
#define VNC_FEATURE_RESIZE_MASK              (1 << VNC_FEATURE_RESIZE)
267
#define VNC_FEATURE_HEXTILE_MASK             (1 << VNC_FEATURE_HEXTILE)
268
#define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
269
#define VNC_FEATURE_WMVI_MASK                (1 << VNC_FEATURE_WMVI)
270
#define VNC_FEATURE_TIGHT_MASK               (1 << VNC_FEATURE_TIGHT)
271
#define VNC_FEATURE_ZLIB_MASK                (1 << VNC_FEATURE_ZLIB)
272
#define VNC_FEATURE_COPYRECT_MASK            (1 << VNC_FEATURE_COPYRECT)
273

    
274

    
275
/*****************************************************************************
276
 *
277
 * Internal APIs
278
 *
279
 *****************************************************************************/
280

    
281
/* Event loop functions */
282
void vnc_client_read(void *opaque);
283
void vnc_client_write(void *opaque);
284

    
285
long vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
286
long vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);
287

    
288
/* Protocol I/O functions */
289
void vnc_write(VncState *vs, const void *data, size_t len);
290
void vnc_write_u32(VncState *vs, uint32_t value);
291
void vnc_write_s32(VncState *vs, int32_t value);
292
void vnc_write_u16(VncState *vs, uint16_t value);
293
void vnc_write_u8(VncState *vs, uint8_t value);
294
void vnc_flush(VncState *vs);
295
void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);
296

    
297

    
298
/* Buffer I/O functions */
299
uint8_t read_u8(uint8_t *data, size_t offset);
300
uint16_t read_u16(uint8_t *data, size_t offset);
301
int32_t read_s32(uint8_t *data, size_t offset);
302
uint32_t read_u32(uint8_t *data, size_t offset);
303

    
304
/* Protocol stage functions */
305
void vnc_client_error(VncState *vs);
306
int vnc_client_io_error(VncState *vs, int ret, int last_errno);
307

    
308
void start_client_init(VncState *vs);
309
void start_auth_vnc(VncState *vs);
310

    
311
/* Buffer management */
312
void buffer_reserve(Buffer *buffer, size_t len);
313
int buffer_empty(Buffer *buffer);
314
uint8_t *buffer_end(Buffer *buffer);
315
void buffer_reset(Buffer *buffer);
316
void buffer_append(Buffer *buffer, const void *data, size_t len);
317

    
318

    
319
/* Misc helpers */
320

    
321
char *vnc_socket_local_addr(const char *format, int fd);
322
char *vnc_socket_remote_addr(const char *format, int fd);
323

    
324
#endif /* __QEMU_VNC_H */