xref: /openbmc/qemu/ui/vnc.h (revision 69cc8db4)
13e230dd2SCorentin Chary /*
23e230dd2SCorentin Chary  * QEMU VNC display driver
33e230dd2SCorentin Chary  *
43e230dd2SCorentin Chary  * Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>
53e230dd2SCorentin Chary  * Copyright (C) 2006 Fabrice Bellard
63e230dd2SCorentin Chary  * Copyright (C) 2009 Red Hat, Inc
73e230dd2SCorentin Chary  *
83e230dd2SCorentin Chary  * Permission is hereby granted, free of charge, to any person obtaining a copy
93e230dd2SCorentin Chary  * of this software and associated documentation files (the "Software"), to deal
103e230dd2SCorentin Chary  * in the Software without restriction, including without limitation the rights
113e230dd2SCorentin Chary  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
123e230dd2SCorentin Chary  * copies of the Software, and to permit persons to whom the Software is
133e230dd2SCorentin Chary  * furnished to do so, subject to the following conditions:
143e230dd2SCorentin Chary  *
153e230dd2SCorentin Chary  * The above copyright notice and this permission notice shall be included in
163e230dd2SCorentin Chary  * all copies or substantial portions of the Software.
173e230dd2SCorentin Chary  *
183e230dd2SCorentin Chary  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
193e230dd2SCorentin Chary  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
203e230dd2SCorentin Chary  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
213e230dd2SCorentin Chary  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
223e230dd2SCorentin Chary  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
233e230dd2SCorentin Chary  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
243e230dd2SCorentin Chary  * THE SOFTWARE.
253e230dd2SCorentin Chary  */
263e230dd2SCorentin Chary 
272a6a4076SMarkus Armbruster #ifndef QEMU_VNC_H
282a6a4076SMarkus Armbruster #define QEMU_VNC_H
293e230dd2SCorentin Chary 
301de7afc9SPaolo Bonzini #include "qemu/queue.h"
311de7afc9SPaolo Bonzini #include "qemu/thread.h"
3228ecbaeeSPaolo Bonzini #include "ui/console.h"
333e230dd2SCorentin Chary #include "audio/audio.h"
341de7afc9SPaolo Bonzini #include "qemu/bitmap.h"
353e305e4aSDaniel P. Berrange #include "crypto/tlssession.h"
3688c5f205SDaniel P. Berrange #include "qemu/buffer.h"
3704d2529dSDaniel P. Berrange #include "io/channel-socket.h"
382cc45228SDaniel P. Berrange #include "io/channel-tls.h"
3913e1d0e7SDaniel P. Berrange #include "io/net-listener.h"
40b76806d4SDaniel P. Berrange #include "authz/base.h"
413e230dd2SCorentin Chary #include <zlib.h>
423e230dd2SCorentin Chary 
433e230dd2SCorentin Chary #include "keymaps.h"
44148954faSCorentin Chary #include "vnc-palette.h"
45148954faSCorentin Chary #include "vnc-enc-zrle.h"
46c2f2ba49SGerd Hoffmann #include "ui/kbd-state.h"
473e230dd2SCorentin Chary 
483e230dd2SCorentin Chary // #define _VNC_DEBUG 1
493e230dd2SCorentin Chary 
503e230dd2SCorentin Chary #ifdef _VNC_DEBUG
513e230dd2SCorentin Chary #define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
523e230dd2SCorentin Chary #else
533e230dd2SCorentin Chary #define VNC_DEBUG(fmt, ...) do { } while (0)
543e230dd2SCorentin Chary #endif
553e230dd2SCorentin Chary 
563e230dd2SCorentin Chary /*****************************************************************************
573e230dd2SCorentin Chary  *
583e230dd2SCorentin Chary  * Core data structures
593e230dd2SCorentin Chary  *
603e230dd2SCorentin Chary  *****************************************************************************/
613e230dd2SCorentin Chary 
623e230dd2SCorentin Chary typedef struct VncState VncState;
63bd023f95SCorentin Chary typedef struct VncJob VncJob;
64bd023f95SCorentin Chary typedef struct VncRect VncRect;
65bd023f95SCorentin Chary typedef struct VncRectEntry VncRectEntry;
663e230dd2SCorentin Chary 
673e230dd2SCorentin Chary typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len);
683e230dd2SCorentin Chary 
699f64916dSGerd Hoffmann typedef void VncWritePixels(VncState *vs, void *data, int size);
703e230dd2SCorentin Chary 
713e230dd2SCorentin Chary typedef void VncSendHextileTile(VncState *vs,
723e230dd2SCorentin Chary                                 int x, int y, int w, int h,
733e230dd2SCorentin Chary                                 void *last_bg,
743e230dd2SCorentin Chary                                 void *last_fg,
753e230dd2SCorentin Chary                                 int *has_bg, int *has_fg);
763e230dd2SCorentin Chary 
77b4c85ddcSPeter Lieven /* VNC_DIRTY_PIXELS_PER_BIT is the number of dirty pixels represented
78bea60dd7SPeter Lieven  * by one bit in the dirty bitmap, should be a power of 2 */
79b4c85ddcSPeter Lieven #define VNC_DIRTY_PIXELS_PER_BIT 16
80b4c85ddcSPeter Lieven 
81bea60dd7SPeter Lieven /* VNC_MAX_WIDTH must be a multiple of VNC_DIRTY_PIXELS_PER_BIT. */
82bea60dd7SPeter Lieven 
83bea60dd7SPeter Lieven #define VNC_MAX_WIDTH ROUND_UP(2560, VNC_DIRTY_PIXELS_PER_BIT)
84bea60dd7SPeter Lieven #define VNC_MAX_HEIGHT 2048
85bea60dd7SPeter Lieven 
8623bfe28fSStefan Weil /* VNC_DIRTY_BITS is the number of bits in the dirty bitmap. */
87b4c85ddcSPeter Lieven #define VNC_DIRTY_BITS (VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT)
883e230dd2SCorentin Chary 
8912b316d4SPeter Lieven /* VNC_DIRTY_BPL (BPL = bits per line) might be greater than
9012b316d4SPeter Lieven  * VNC_DIRTY_BITS due to alignment */
9112b316d4SPeter Lieven #define VNC_DIRTY_BPL(x) (sizeof((x)->dirty) / VNC_MAX_HEIGHT * BITS_PER_BYTE)
9212b316d4SPeter Lieven 
93999342a0SCorentin Chary #define VNC_STAT_RECT  64
94999342a0SCorentin Chary #define VNC_STAT_COLS (VNC_MAX_WIDTH / VNC_STAT_RECT)
95999342a0SCorentin Chary #define VNC_STAT_ROWS (VNC_MAX_HEIGHT / VNC_STAT_RECT)
96999342a0SCorentin Chary 
973e230dd2SCorentin Chary #define VNC_AUTH_CHALLENGE_SIZE 16
983e230dd2SCorentin Chary 
993e230dd2SCorentin Chary typedef struct VncDisplay VncDisplay;
1003e230dd2SCorentin Chary 
1013e230dd2SCorentin Chary #include "vnc-auth-vencrypt.h"
1023e230dd2SCorentin Chary #ifdef CONFIG_VNC_SASL
1033e230dd2SCorentin Chary #include "vnc-auth-sasl.h"
1043e230dd2SCorentin Chary #endif
1057536ee4bSTim Hardeck #include "vnc-ws.h"
1063e230dd2SCorentin Chary 
107999342a0SCorentin Chary struct VncRectStat
108999342a0SCorentin Chary {
109999342a0SCorentin Chary     /* time of last 10 updates, to find update frequency */
110999342a0SCorentin Chary     struct timeval times[10];
111999342a0SCorentin Chary     int idx;
112999342a0SCorentin Chary 
113999342a0SCorentin Chary     double freq;        /* Update frequency (in Hz) */
114999342a0SCorentin Chary     bool updated;       /* Already updated during this refresh */
115999342a0SCorentin Chary };
116999342a0SCorentin Chary 
117999342a0SCorentin Chary typedef struct VncRectStat VncRectStat;
118999342a0SCorentin Chary 
1193e230dd2SCorentin Chary struct VncSurface
1203e230dd2SCorentin Chary {
121999342a0SCorentin Chary     struct timeval last_freq_check;
122bea60dd7SPeter Lieven     DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT],
123bea60dd7SPeter Lieven                    VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT);
124999342a0SCorentin Chary     VncRectStat stats[VNC_STAT_ROWS][VNC_STAT_COLS];
1259f64916dSGerd Hoffmann     pixman_image_t *fb;
1269f64916dSGerd Hoffmann     pixman_format_code_t format;
1273e230dd2SCorentin Chary };
1283e230dd2SCorentin Chary 
1298cf36489SGerd Hoffmann typedef enum VncShareMode {
1308cf36489SGerd Hoffmann     VNC_SHARE_MODE_CONNECTING = 1,
1318cf36489SGerd Hoffmann     VNC_SHARE_MODE_SHARED,
1328cf36489SGerd Hoffmann     VNC_SHARE_MODE_EXCLUSIVE,
1338cf36489SGerd Hoffmann     VNC_SHARE_MODE_DISCONNECTED,
1348cf36489SGerd Hoffmann } VncShareMode;
1358cf36489SGerd Hoffmann 
1368cf36489SGerd Hoffmann typedef enum VncSharePolicy {
1378cf36489SGerd Hoffmann     VNC_SHARE_POLICY_IGNORE = 1,
1388cf36489SGerd Hoffmann     VNC_SHARE_POLICY_ALLOW_EXCLUSIVE,
1398cf36489SGerd Hoffmann     VNC_SHARE_POLICY_FORCE_SHARED,
1408cf36489SGerd Hoffmann } VncSharePolicy;
1418cf36489SGerd Hoffmann 
1423e230dd2SCorentin Chary struct VncDisplay
1433e230dd2SCorentin Chary {
1443e230dd2SCorentin Chary     QTAILQ_HEAD(, VncState) clients;
145e5f34cddSGerd Hoffmann     int num_connecting;
146e5f34cddSGerd Hoffmann     int num_shared;
1478cf36489SGerd Hoffmann     int num_exclusive;
148e5f34cddSGerd Hoffmann     int connections_limit;
1498cf36489SGerd Hoffmann     VncSharePolicy share_policy;
15013e1d0e7SDaniel P. Berrange     QIONetListener *listener;
15113e1d0e7SDaniel P. Berrange     QIONetListener *wslistener;
152d39fa6d8SGerd Hoffmann     DisplaySurface *ds;
15321ef45d7SGerd Hoffmann     DisplayChangeListener dcl;
1543e230dd2SCorentin Chary     kbd_layout_t *kbd_layout;
1553e230dd2SCorentin Chary     int lock_key_sync;
156a54f0d2bSPierre Ossman     QEMUPutLEDEntry *led;
157a54f0d2bSPierre Ossman     int ledstate;
158c2f2ba49SGerd Hoffmann     QKbdState *kbd;
159bd023f95SCorentin Chary     QemuMutex mutex;
1603e230dd2SCorentin Chary 
1613e230dd2SCorentin Chary     QEMUCursor *cursor;
1623e230dd2SCorentin Chary     int cursor_msize;
1633e230dd2SCorentin Chary     uint8_t *cursor_mask;
1643e230dd2SCorentin Chary 
1653e230dd2SCorentin Chary     struct VncSurface guest;   /* guest visible surface (aka ds->surface) */
1669f64916dSGerd Hoffmann     pixman_image_t *server;    /* vnc server surface */
167*69cc8db4SDaniel P. Berrangé     int true_width; /* server surface width before rounding up */
1683e230dd2SCorentin Chary 
169d616ccc5SGerd Hoffmann     const char *id;
170d616ccc5SGerd Hoffmann     QTAILQ_ENTRY(VncDisplay) next;
171bf7aa45eSGerd Hoffmann     bool is_unix;
1723e230dd2SCorentin Chary     char *password;
1733c9405a0SGerd Hoffmann     time_t expires;
1743e230dd2SCorentin Chary     int auth;
175d169f04bSDaniel P. Berrange     int subauth; /* Used by VeNCrypt */
176f9148c8aSDaniel P. Berrange     int ws_auth; /* Used by websockets */
177eda24e18SDaniel P. Berrange     int ws_subauth; /* Used by websockets */
1783e230dd2SCorentin Chary     bool lossy;
17980e0c8c3SCorentin Chary     bool non_adaptive;
1807b5fa0b5SDaniel P. Berrangé     bool power_control;
1813e305e4aSDaniel P. Berrange     QCryptoTLSCreds *tlscreds;
182b76806d4SDaniel P. Berrange     QAuthZ *tlsauthz;
183b76806d4SDaniel P. Berrange     char *tlsauthzid;
1843e230dd2SCorentin Chary #ifdef CONFIG_VNC_SASL
1853e230dd2SCorentin Chary     VncDisplaySASL sasl;
1863e230dd2SCorentin Chary #endif
187f0b9f36dSKővágó, Zoltán 
188f0b9f36dSKővágó, Zoltán     AudioState *audio_state;
1893e230dd2SCorentin Chary };
1903e230dd2SCorentin Chary 
191d1af0e05SCorentin Chary typedef struct VncTight {
192d1af0e05SCorentin Chary     int type;
193d1af0e05SCorentin Chary     uint8_t quality;
194d1af0e05SCorentin Chary     uint8_t compression;
195d1af0e05SCorentin Chary     uint8_t pixel24;
196d1af0e05SCorentin Chary     Buffer tight;
197d1af0e05SCorentin Chary     Buffer tmp;
198d1af0e05SCorentin Chary     Buffer zlib;
199d1af0e05SCorentin Chary     Buffer gradient;
200d1af0e05SCorentin Chary #ifdef CONFIG_VNC_JPEG
201d1af0e05SCorentin Chary     Buffer jpeg;
202d1af0e05SCorentin Chary #endif
203d1af0e05SCorentin Chary #ifdef CONFIG_VNC_PNG
204d1af0e05SCorentin Chary     Buffer png;
205d1af0e05SCorentin Chary #endif
206d1af0e05SCorentin Chary     int levels[4];
207d1af0e05SCorentin Chary     z_stream stream[4];
208d1af0e05SCorentin Chary } VncTight;
209d1af0e05SCorentin Chary 
210d1af0e05SCorentin Chary typedef struct VncHextile {
211d1af0e05SCorentin Chary     VncSendHextileTile *send_tile;
212d1af0e05SCorentin Chary } VncHextile;
213d1af0e05SCorentin Chary 
214d1af0e05SCorentin Chary typedef struct VncZlib {
215d1af0e05SCorentin Chary     Buffer zlib;
216d1af0e05SCorentin Chary     Buffer tmp;
217d1af0e05SCorentin Chary     z_stream stream;
218d1af0e05SCorentin Chary     int level;
219d1af0e05SCorentin Chary } VncZlib;
220d1af0e05SCorentin Chary 
221148954faSCorentin Chary typedef struct VncZrle {
222148954faSCorentin Chary     int type;
223148954faSCorentin Chary     Buffer fb;
224148954faSCorentin Chary     Buffer zrle;
225148954faSCorentin Chary     Buffer tmp;
226148954faSCorentin Chary     Buffer zlib;
227148954faSCorentin Chary     z_stream stream;
228148954faSCorentin Chary     VncPalette palette;
229148954faSCorentin Chary } VncZrle;
230148954faSCorentin Chary 
231148954faSCorentin Chary typedef struct VncZywrle {
232148954faSCorentin Chary     int buf[VNC_ZRLE_TILE_WIDTH * VNC_ZRLE_TILE_HEIGHT];
233148954faSCorentin Chary } VncZywrle;
234148954faSCorentin Chary 
235bd023f95SCorentin Chary struct VncRect
236bd023f95SCorentin Chary {
237bd023f95SCorentin Chary     int x;
238bd023f95SCorentin Chary     int y;
239bd023f95SCorentin Chary     int w;
240bd023f95SCorentin Chary     int h;
241bd023f95SCorentin Chary };
242bd023f95SCorentin Chary 
243bd023f95SCorentin Chary struct VncRectEntry
244bd023f95SCorentin Chary {
245bd023f95SCorentin Chary     struct VncRect rect;
246bd023f95SCorentin Chary     QLIST_ENTRY(VncRectEntry) next;
247bd023f95SCorentin Chary };
248bd023f95SCorentin Chary 
249bd023f95SCorentin Chary struct VncJob
250bd023f95SCorentin Chary {
251bd023f95SCorentin Chary     VncState *vs;
252bd023f95SCorentin Chary 
253bd023f95SCorentin Chary     QLIST_HEAD(, VncRectEntry) rectangles;
254bd023f95SCorentin Chary     QTAILQ_ENTRY(VncJob) next;
255bd023f95SCorentin Chary };
256bd023f95SCorentin Chary 
257fef1bbadSDaniel P. Berrange typedef enum {
258fef1bbadSDaniel P. Berrange     VNC_STATE_UPDATE_NONE,
259fef1bbadSDaniel P. Berrange     VNC_STATE_UPDATE_INCREMENTAL,
260fef1bbadSDaniel P. Berrange     VNC_STATE_UPDATE_FORCE,
261fef1bbadSDaniel P. Berrange } VncStateUpdate;
262fef1bbadSDaniel P. Berrange 
263f31f9c10SGerd Hoffmann #define VNC_MAGIC ((uint64_t)0x05b3f069b3d204bb)
264f31f9c10SGerd Hoffmann 
2653e230dd2SCorentin Chary struct VncState
2663e230dd2SCorentin Chary {
267f31f9c10SGerd Hoffmann     uint64_t magic;
26804d2529dSDaniel P. Berrange     QIOChannelSocket *sioc; /* The underlying socket */
26904d2529dSDaniel P. Berrange     QIOChannel *ioc; /* The channel currently used for I/O */
27004d2529dSDaniel P. Berrange     guint ioc_tag;
27104d2529dSDaniel P. Berrange     gboolean disconnecting;
2723e230dd2SCorentin Chary 
27323bfe28fSStefan Weil     DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_DIRTY_BITS);
2747d964c9dSCorentin Chary     uint8_t **lossy_rect; /* Not an Array to avoid costly memcpy in
2757d964c9dSCorentin Chary                            * vnc-jobs-async.c */
2763e230dd2SCorentin Chary 
2773e230dd2SCorentin Chary     VncDisplay *vd;
278fef1bbadSDaniel P. Berrange     VncStateUpdate update; /* Most recent pending request from client */
279ada8d2e4SDaniel P. Berrange     VncStateUpdate job_update; /* Currently processed by job thread */
28063658280SGerd Hoffmann     int has_dirty;
2813e230dd2SCorentin Chary     uint32_t features;
2823e230dd2SCorentin Chary     int absolute;
2833e230dd2SCorentin Chary     int last_x;
2843e230dd2SCorentin Chary     int last_y;
28514768ebaSGerd Hoffmann     uint32_t last_bmask;
2864c956bd8SDaniel P. Berrange     size_t client_width; /* limited to u16 by RFB proto */
2874c956bd8SDaniel P. Berrange     size_t client_height; /* limited to u16 by RFB proto */
2888cf36489SGerd Hoffmann     VncShareMode share_mode;
2893e230dd2SCorentin Chary 
2903e230dd2SCorentin Chary     uint32_t vnc_encoding;
2913e230dd2SCorentin Chary 
2923e230dd2SCorentin Chary     int major;
2933e230dd2SCorentin Chary     int minor;
2943e230dd2SCorentin Chary 
2957e7e2ebcSDaniel P. Berrange     int auth;
296d169f04bSDaniel P. Berrange     int subauth; /* Used by VeNCrypt */
2973e230dd2SCorentin Chary     char challenge[VNC_AUTH_CHALLENGE_SIZE];
2982cc45228SDaniel P. Berrange     QCryptoTLSSession *tls; /* Borrowed pointer from channel, don't free */
2993e230dd2SCorentin Chary #ifdef CONFIG_VNC_SASL
3003e230dd2SCorentin Chary     VncStateSASL sasl;
3013e230dd2SCorentin Chary #endif
3027536ee4bSTim Hardeck     bool encode_ws;
3037536ee4bSTim Hardeck     bool websocket;
3043e230dd2SCorentin Chary 
30505eb4a25SMarc-André Lureau #ifdef CONFIG_VNC
306fb6ba0d5SWenchao Xia     VncClientInfo *info;
30705eb4a25SMarc-André Lureau #endif
3083e230dd2SCorentin Chary 
309ada8d2e4SDaniel P. Berrange     /* Job thread bottom half has put data for a forced update
310ada8d2e4SDaniel P. Berrange      * into the output buffer. This offset points to the end of
311ada8d2e4SDaniel P. Berrange      * the update data in the output buffer. This lets us determine
312ada8d2e4SDaniel P. Berrange      * when a force update is fully sent to the client, allowing
313ada8d2e4SDaniel P. Berrange      * us to process further forced updates. */
314ada8d2e4SDaniel P. Berrange     size_t force_update_offset;
315e2b72cb6SDaniel P. Berrange     /* We allow multiple incremental updates or audio capture
316e2b72cb6SDaniel P. Berrange      * samples to be queued in output buffer, provided the
317e2b72cb6SDaniel P. Berrange      * buffer size doesn't exceed this threshold. The value
318e2b72cb6SDaniel P. Berrange      * is calculating dynamically based on framebuffer size
319e2b72cb6SDaniel P. Berrange      * and audio sample settings in vnc_update_throttle_offset() */
320e2b72cb6SDaniel P. Berrange     size_t throttle_output_offset;
3213e230dd2SCorentin Chary     Buffer output;
3223e230dd2SCorentin Chary     Buffer input;
3233e230dd2SCorentin Chary     /* current output mode information */
3243e230dd2SCorentin Chary     VncWritePixels *write_pixels;
3259f64916dSGerd Hoffmann     PixelFormat client_pf;
3269f64916dSGerd Hoffmann     pixman_format_code_t client_format;
3279f64916dSGerd Hoffmann     bool client_be;
3283e230dd2SCorentin Chary 
3293e230dd2SCorentin Chary     CaptureVoiceOut *audio_cap;
3303e230dd2SCorentin Chary     struct audsettings as;
3313e230dd2SCorentin Chary 
3323e230dd2SCorentin Chary     VncReadEvent *read_handler;
3333e230dd2SCorentin Chary     size_t read_handler_expect;
3343e230dd2SCorentin Chary 
335bd023f95SCorentin Chary     bool abort;
336bd023f95SCorentin Chary     QemuMutex output_mutex;
337175b2a6eSCorentin Chary     QEMUBH *bh;
338175b2a6eSCorentin Chary     Buffer jobs_buffer;
339bd023f95SCorentin Chary 
340bd023f95SCorentin Chary     /* Encoding specific, if you add something here, don't forget to
341bd023f95SCorentin Chary      *  update vnc_async_encoding_start()
342bd023f95SCorentin Chary      */
3436bf21f3dSLi Qiang     VncTight *tight;
344d1af0e05SCorentin Chary     VncZlib zlib;
345d1af0e05SCorentin Chary     VncHextile hextile;
3466bf21f3dSLi Qiang     VncZrle *zrle;
347148954faSCorentin Chary     VncZywrle zywrle;
3483e230dd2SCorentin Chary 
3493e230dd2SCorentin Chary     Notifier mouse_mode_notifier;
3503e230dd2SCorentin Chary 
3513e230dd2SCorentin Chary     QTAILQ_ENTRY(VncState) next;
3523e230dd2SCorentin Chary };
3533e230dd2SCorentin Chary 
3543e230dd2SCorentin Chary 
3553e230dd2SCorentin Chary /*****************************************************************************
3563e230dd2SCorentin Chary  *
3573e230dd2SCorentin Chary  * Authentication modes
3583e230dd2SCorentin Chary  *
3593e230dd2SCorentin Chary  *****************************************************************************/
3603e230dd2SCorentin Chary 
3613e230dd2SCorentin Chary enum {
3623e230dd2SCorentin Chary     VNC_AUTH_INVALID = 0,
3633e230dd2SCorentin Chary     VNC_AUTH_NONE = 1,
3643e230dd2SCorentin Chary     VNC_AUTH_VNC = 2,
3653e230dd2SCorentin Chary     VNC_AUTH_RA2 = 5,
3663e230dd2SCorentin Chary     VNC_AUTH_RA2NE = 6,
3673e230dd2SCorentin Chary     VNC_AUTH_TIGHT = 16,
3683e230dd2SCorentin Chary     VNC_AUTH_ULTRA = 17,
3693e230dd2SCorentin Chary     VNC_AUTH_TLS = 18,      /* Supported in GTK-VNC & VINO */
3703e230dd2SCorentin Chary     VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */
3713e230dd2SCorentin Chary     VNC_AUTH_SASL = 20,     /* Supported in GTK-VNC & VINO */
3723e230dd2SCorentin Chary };
3733e230dd2SCorentin Chary 
3743e230dd2SCorentin Chary enum {
3753e230dd2SCorentin Chary     VNC_AUTH_VENCRYPT_PLAIN = 256,
3763e230dd2SCorentin Chary     VNC_AUTH_VENCRYPT_TLSNONE = 257,
3773e230dd2SCorentin Chary     VNC_AUTH_VENCRYPT_TLSVNC = 258,
3783e230dd2SCorentin Chary     VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
3793e230dd2SCorentin Chary     VNC_AUTH_VENCRYPT_X509NONE = 260,
3803e230dd2SCorentin Chary     VNC_AUTH_VENCRYPT_X509VNC = 261,
3813e230dd2SCorentin Chary     VNC_AUTH_VENCRYPT_X509PLAIN = 262,
3823e230dd2SCorentin Chary     VNC_AUTH_VENCRYPT_X509SASL = 263,
3833e230dd2SCorentin Chary     VNC_AUTH_VENCRYPT_TLSSASL = 264,
3843e230dd2SCorentin Chary };
3853e230dd2SCorentin Chary 
3863e230dd2SCorentin Chary 
3873e230dd2SCorentin Chary /*****************************************************************************
3883e230dd2SCorentin Chary  *
3893e230dd2SCorentin Chary  * Encoding types
3903e230dd2SCorentin Chary  *
3913e230dd2SCorentin Chary  *****************************************************************************/
3923e230dd2SCorentin Chary 
3933e230dd2SCorentin Chary #define VNC_ENCODING_RAW                  0x00000000
3943e230dd2SCorentin Chary #define VNC_ENCODING_COPYRECT             0x00000001
3953e230dd2SCorentin Chary #define VNC_ENCODING_RRE                  0x00000002
3963e230dd2SCorentin Chary #define VNC_ENCODING_CORRE                0x00000004
3973e230dd2SCorentin Chary #define VNC_ENCODING_HEXTILE              0x00000005
3983e230dd2SCorentin Chary #define VNC_ENCODING_ZLIB                 0x00000006
3993e230dd2SCorentin Chary #define VNC_ENCODING_TIGHT                0x00000007
4003e230dd2SCorentin Chary #define VNC_ENCODING_ZLIBHEX              0x00000008
4013e230dd2SCorentin Chary #define VNC_ENCODING_TRLE                 0x0000000f
4023e230dd2SCorentin Chary #define VNC_ENCODING_ZRLE                 0x00000010
4033e230dd2SCorentin Chary #define VNC_ENCODING_ZYWRLE               0x00000011
4043e230dd2SCorentin Chary #define VNC_ENCODING_COMPRESSLEVEL0       0xFFFFFF00 /* -256 */
4053e230dd2SCorentin Chary #define VNC_ENCODING_QUALITYLEVEL0        0xFFFFFFE0 /* -32  */
4063e230dd2SCorentin Chary #define VNC_ENCODING_XCURSOR              0xFFFFFF10 /* -240 */
4073e230dd2SCorentin Chary #define VNC_ENCODING_RICH_CURSOR          0xFFFFFF11 /* -239 */
4083e230dd2SCorentin Chary #define VNC_ENCODING_POINTER_POS          0xFFFFFF18 /* -232 */
4093e230dd2SCorentin Chary #define VNC_ENCODING_LASTRECT             0xFFFFFF20 /* -224 */
4103e230dd2SCorentin Chary #define VNC_ENCODING_DESKTOPRESIZE        0xFFFFFF21 /* -223 */
4113e230dd2SCorentin Chary #define VNC_ENCODING_POINTER_TYPE_CHANGE  0XFFFFFEFF /* -257 */
4123e230dd2SCorentin Chary #define VNC_ENCODING_EXT_KEY_EVENT        0XFFFFFEFE /* -258 */
4133e230dd2SCorentin Chary #define VNC_ENCODING_AUDIO                0XFFFFFEFD /* -259 */
414efe556adSCorentin Chary #define VNC_ENCODING_TIGHT_PNG            0xFFFFFEFC /* -260 */
415ab99e5c1SLei Li #define VNC_ENCODING_LED_STATE            0XFFFFFEFB /* -261 */
416a7d83e43SGerd Hoffmann #define VNC_ENCODING_DESKTOP_RESIZE_EXT   0XFFFFFECC /* -308 */
4177b5fa0b5SDaniel P. Berrangé #define VNC_ENCODING_XVP                  0XFFFFFECB /* -309 */
418a7d83e43SGerd Hoffmann #define VNC_ENCODING_ALPHA_CURSOR         0XFFFFFEC6 /* -314 */
4193e230dd2SCorentin Chary #define VNC_ENCODING_WMVi                 0x574D5669
4203e230dd2SCorentin Chary 
4213e230dd2SCorentin Chary /*****************************************************************************
4223e230dd2SCorentin Chary  *
4233e230dd2SCorentin Chary  * Other tight constants
4243e230dd2SCorentin Chary  *
4253e230dd2SCorentin Chary  *****************************************************************************/
4263e230dd2SCorentin Chary 
4273e230dd2SCorentin Chary /*
4283e230dd2SCorentin Chary  * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
4293e230dd2SCorentin Chary  */
4303e230dd2SCorentin Chary 
4313e230dd2SCorentin Chary #define VNC_TIGHT_CCB_RESET_MASK   (0x0f)
4323e230dd2SCorentin Chary #define VNC_TIGHT_CCB_TYPE_MASK    (0x0f << 4)
4333e230dd2SCorentin Chary #define VNC_TIGHT_CCB_TYPE_FILL    (0x08 << 4)
4343e230dd2SCorentin Chary #define VNC_TIGHT_CCB_TYPE_JPEG    (0x09 << 4)
435efe556adSCorentin Chary #define VNC_TIGHT_CCB_TYPE_PNG     (0x0A << 4)
4363e230dd2SCorentin Chary #define VNC_TIGHT_CCB_BASIC_MAX    (0x07 << 4)
4373e230dd2SCorentin Chary #define VNC_TIGHT_CCB_BASIC_ZLIB   (0x03 << 4)
4383e230dd2SCorentin Chary #define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
4393e230dd2SCorentin Chary 
4403e230dd2SCorentin Chary /*****************************************************************************
4413e230dd2SCorentin Chary  *
4423e230dd2SCorentin Chary  * Features
4433e230dd2SCorentin Chary  *
4443e230dd2SCorentin Chary  *****************************************************************************/
4453e230dd2SCorentin Chary 
446b0c693faSGerd Hoffmann enum VncFeatures {
447b0c693faSGerd Hoffmann     VNC_FEATURE_RESIZE,
448763deea7SGerd Hoffmann     VNC_FEATURE_RESIZE_EXT,
449b0c693faSGerd Hoffmann     VNC_FEATURE_HEXTILE,
450b0c693faSGerd Hoffmann     VNC_FEATURE_POINTER_TYPE_CHANGE,
451b0c693faSGerd Hoffmann     VNC_FEATURE_WMVI,
452b0c693faSGerd Hoffmann     VNC_FEATURE_TIGHT,
453b0c693faSGerd Hoffmann     VNC_FEATURE_ZLIB,
454b0c693faSGerd Hoffmann     VNC_FEATURE_RICH_CURSOR,
455074a86d0SGerd Hoffmann     VNC_FEATURE_ALPHA_CURSOR,
456b0c693faSGerd Hoffmann     VNC_FEATURE_TIGHT_PNG,
457b0c693faSGerd Hoffmann     VNC_FEATURE_ZRLE,
458b0c693faSGerd Hoffmann     VNC_FEATURE_ZYWRLE,
459b0c693faSGerd Hoffmann     VNC_FEATURE_LED_STATE,
4607b5fa0b5SDaniel P. Berrangé     VNC_FEATURE_XVP,
461b0c693faSGerd Hoffmann };
4623e230dd2SCorentin Chary 
4633e230dd2SCorentin Chary #define VNC_FEATURE_RESIZE_MASK              (1 << VNC_FEATURE_RESIZE)
464763deea7SGerd Hoffmann #define VNC_FEATURE_RESIZE_EXT_MASK          (1 << VNC_FEATURE_RESIZE_EXT)
4653e230dd2SCorentin Chary #define VNC_FEATURE_HEXTILE_MASK             (1 << VNC_FEATURE_HEXTILE)
4663e230dd2SCorentin Chary #define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
4673e230dd2SCorentin Chary #define VNC_FEATURE_WMVI_MASK                (1 << VNC_FEATURE_WMVI)
4683e230dd2SCorentin Chary #define VNC_FEATURE_TIGHT_MASK               (1 << VNC_FEATURE_TIGHT)
4693e230dd2SCorentin Chary #define VNC_FEATURE_ZLIB_MASK                (1 << VNC_FEATURE_ZLIB)
4703e230dd2SCorentin Chary #define VNC_FEATURE_RICH_CURSOR_MASK         (1 << VNC_FEATURE_RICH_CURSOR)
471074a86d0SGerd Hoffmann #define VNC_FEATURE_ALPHA_CURSOR_MASK        (1 << VNC_FEATURE_ALPHA_CURSOR)
472efe556adSCorentin Chary #define VNC_FEATURE_TIGHT_PNG_MASK           (1 << VNC_FEATURE_TIGHT_PNG)
473148954faSCorentin Chary #define VNC_FEATURE_ZRLE_MASK                (1 << VNC_FEATURE_ZRLE)
474148954faSCorentin Chary #define VNC_FEATURE_ZYWRLE_MASK              (1 << VNC_FEATURE_ZYWRLE)
475ab99e5c1SLei Li #define VNC_FEATURE_LED_STATE_MASK           (1 << VNC_FEATURE_LED_STATE)
4767b5fa0b5SDaniel P. Berrangé #define VNC_FEATURE_XVP_MASK                 (1 << VNC_FEATURE_XVP)
4773e230dd2SCorentin Chary 
4783e230dd2SCorentin Chary 
4793e230dd2SCorentin Chary /* Client -> Server message IDs */
4803e230dd2SCorentin Chary #define VNC_MSG_CLIENT_SET_PIXEL_FORMAT           0
4813e230dd2SCorentin Chary #define VNC_MSG_CLIENT_SET_ENCODINGS              2
4823e230dd2SCorentin Chary #define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
4833e230dd2SCorentin Chary #define VNC_MSG_CLIENT_KEY_EVENT                  4
4843e230dd2SCorentin Chary #define VNC_MSG_CLIENT_POINTER_EVENT              5
4853e230dd2SCorentin Chary #define VNC_MSG_CLIENT_CUT_TEXT                   6
4863e230dd2SCorentin Chary #define VNC_MSG_CLIENT_VMWARE_0                   127
4873e230dd2SCorentin Chary #define VNC_MSG_CLIENT_CALL_CONTROL               249
4883e230dd2SCorentin Chary #define VNC_MSG_CLIENT_XVP                        250
4893e230dd2SCorentin Chary #define VNC_MSG_CLIENT_SET_DESKTOP_SIZE           251
4903e230dd2SCorentin Chary #define VNC_MSG_CLIENT_TIGHT                      252
4913e230dd2SCorentin Chary #define VNC_MSG_CLIENT_GII                        253
4923e230dd2SCorentin Chary #define VNC_MSG_CLIENT_VMWARE_1                   254
4933e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU                       255
4943e230dd2SCorentin Chary 
4953e230dd2SCorentin Chary /* Server -> Client message IDs */
4963e230dd2SCorentin Chary #define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE         0
4973e230dd2SCorentin Chary #define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES     1
4983e230dd2SCorentin Chary #define VNC_MSG_SERVER_BELL                       2
4993e230dd2SCorentin Chary #define VNC_MSG_SERVER_CUT_TEXT                   3
5003e230dd2SCorentin Chary #define VNC_MSG_SERVER_VMWARE_0                   127
5013e230dd2SCorentin Chary #define VNC_MSG_SERVER_CALL_CONTROL               249
5023e230dd2SCorentin Chary #define VNC_MSG_SERVER_XVP                        250
5033e230dd2SCorentin Chary #define VNC_MSG_SERVER_TIGHT                      252
5043e230dd2SCorentin Chary #define VNC_MSG_SERVER_GII                        253
5053e230dd2SCorentin Chary #define VNC_MSG_SERVER_VMWARE_1                   254
5063e230dd2SCorentin Chary #define VNC_MSG_SERVER_QEMU                       255
5073e230dd2SCorentin Chary 
5083e230dd2SCorentin Chary 
5093e230dd2SCorentin Chary 
5103e230dd2SCorentin Chary /* QEMU client -> server message IDs */
5113e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT         0
5123e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU_AUDIO                 1
5133e230dd2SCorentin Chary 
5143e230dd2SCorentin Chary /* QEMU server -> client message IDs */
5153e230dd2SCorentin Chary #define VNC_MSG_SERVER_QEMU_AUDIO                 1
5163e230dd2SCorentin Chary 
5173e230dd2SCorentin Chary 
5183e230dd2SCorentin Chary 
5193e230dd2SCorentin Chary /* QEMU client -> server audio message IDs */
5203e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE          0
5213e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE         1
5223e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT      2
5233e230dd2SCorentin Chary 
5243e230dd2SCorentin Chary /* QEMU server -> client audio message IDs */
5253e230dd2SCorentin Chary #define VNC_MSG_SERVER_QEMU_AUDIO_END             0
5263e230dd2SCorentin Chary #define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN           1
5273e230dd2SCorentin Chary #define VNC_MSG_SERVER_QEMU_AUDIO_DATA            2
5283e230dd2SCorentin Chary 
5297b5fa0b5SDaniel P. Berrangé /* XVP server -> client status code */
5307b5fa0b5SDaniel P. Berrangé #define VNC_XVP_CODE_FAIL 0
5317b5fa0b5SDaniel P. Berrangé #define VNC_XVP_CODE_INIT 1
5327b5fa0b5SDaniel P. Berrangé 
5337b5fa0b5SDaniel P. Berrangé /* XVP client -> server action request  */
5347b5fa0b5SDaniel P. Berrangé #define VNC_XVP_ACTION_SHUTDOWN 2
5357b5fa0b5SDaniel P. Berrangé #define VNC_XVP_ACTION_REBOOT 3
5367b5fa0b5SDaniel P. Berrangé #define VNC_XVP_ACTION_RESET 4
5377b5fa0b5SDaniel P. Berrangé 
5383e230dd2SCorentin Chary 
5393e230dd2SCorentin Chary /*****************************************************************************
5403e230dd2SCorentin Chary  *
5413e230dd2SCorentin Chary  * Internal APIs
5423e230dd2SCorentin Chary  *
5433e230dd2SCorentin Chary  *****************************************************************************/
5443e230dd2SCorentin Chary 
5453e230dd2SCorentin Chary /* Event loop functions */
54604d2529dSDaniel P. Berrange gboolean vnc_client_io(QIOChannel *ioc,
54704d2529dSDaniel P. Berrange                        GIOCondition condition,
54804d2529dSDaniel P. Berrange                        void *opaque);
5493e230dd2SCorentin Chary 
55030b80fd5SDaniel P. Berrange size_t vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
55130b80fd5SDaniel P. Berrange size_t vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);
5523e230dd2SCorentin Chary 
5533e230dd2SCorentin Chary /* Protocol I/O functions */
5543e230dd2SCorentin Chary void vnc_write(VncState *vs, const void *data, size_t len);
5553e230dd2SCorentin Chary void vnc_write_u32(VncState *vs, uint32_t value);
5563e230dd2SCorentin Chary void vnc_write_s32(VncState *vs, int32_t value);
5573e230dd2SCorentin Chary void vnc_write_u16(VncState *vs, uint16_t value);
5583e230dd2SCorentin Chary void vnc_write_u8(VncState *vs, uint8_t value);
5593e230dd2SCorentin Chary void vnc_flush(VncState *vs);
5603e230dd2SCorentin Chary void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);
5617536ee4bSTim Hardeck void vnc_disconnect_finish(VncState *vs);
562dbee9897SDaniel P. Berrange void vnc_start_protocol(VncState *vs);
5633e230dd2SCorentin Chary 
5643e230dd2SCorentin Chary 
5653e230dd2SCorentin Chary /* Buffer I/O functions */
5663e230dd2SCorentin Chary uint32_t read_u32(uint8_t *data, size_t offset);
5673e230dd2SCorentin Chary 
5683e230dd2SCorentin Chary /* Protocol stage functions */
5693e230dd2SCorentin Chary void vnc_client_error(VncState *vs);
57034ab29c2SVladimir Sementsov-Ogievskiy size_t vnc_client_io_error(VncState *vs, ssize_t ret, Error *err);
5713e230dd2SCorentin Chary 
5723e230dd2SCorentin Chary void start_client_init(VncState *vs);
5733e230dd2SCorentin Chary void start_auth_vnc(VncState *vs);
5743e230dd2SCorentin Chary 
5753e230dd2SCorentin Chary 
5763e230dd2SCorentin Chary /* Misc helpers */
5773e230dd2SCorentin Chary 
578efe556adSCorentin Chary static inline uint32_t vnc_has_feature(VncState *vs, int feature) {
579efe556adSCorentin Chary     return (vs->features & (1 << feature));
580efe556adSCorentin Chary }
581efe556adSCorentin Chary 
5823e230dd2SCorentin Chary /* Framebuffer */
5833e230dd2SCorentin Chary void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
5843e230dd2SCorentin Chary                             int32_t encoding);
5853e230dd2SCorentin Chary 
5869f64916dSGerd Hoffmann /* server fb is in PIXMAN_x8r8g8b8 */
5879f64916dSGerd Hoffmann #define VNC_SERVER_FB_FORMAT PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8)
5889f64916dSGerd Hoffmann #define VNC_SERVER_FB_BITS   (PIXMAN_FORMAT_BPP(VNC_SERVER_FB_FORMAT))
5899f64916dSGerd Hoffmann #define VNC_SERVER_FB_BYTES  ((VNC_SERVER_FB_BITS+7)/8)
5909f64916dSGerd Hoffmann 
5919f64916dSGerd Hoffmann void *vnc_server_fb_ptr(VncDisplay *vd, int x, int y);
5929f64916dSGerd Hoffmann int vnc_server_fb_stride(VncDisplay *vd);
5939f64916dSGerd Hoffmann 
5943e230dd2SCorentin Chary void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v);
595999342a0SCorentin Chary double vnc_update_freq(VncState *vs, int x, int y, int w, int h);
5967d964c9dSCorentin Chary void vnc_sent_lossy_rect(VncState *vs, int x, int y, int w, int h);
5973e230dd2SCorentin Chary 
5983e230dd2SCorentin Chary /* Encodings */
599bd023f95SCorentin Chary int vnc_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
600bd023f95SCorentin Chary 
6013e230dd2SCorentin Chary int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
6023e230dd2SCorentin Chary 
6033e230dd2SCorentin Chary int vnc_hextile_send_framebuffer_update(VncState *vs, int x,
6043e230dd2SCorentin Chary                                          int y, int w, int h);
6053e230dd2SCorentin Chary void vnc_hextile_set_pixel_conversion(VncState *vs, int generic);
6063e230dd2SCorentin Chary 
6073e230dd2SCorentin Chary void *vnc_zlib_zalloc(void *x, unsigned items, unsigned size);
6083e230dd2SCorentin Chary void vnc_zlib_zfree(void *x, void *addr);
6093e230dd2SCorentin Chary int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
6103e230dd2SCorentin Chary void vnc_zlib_clear(VncState *vs);
6113e230dd2SCorentin Chary 
6123e230dd2SCorentin Chary int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
613efe556adSCorentin Chary int vnc_tight_png_send_framebuffer_update(VncState *vs, int x, int y,
614efe556adSCorentin Chary                                           int w, int h);
6153e230dd2SCorentin Chary void vnc_tight_clear(VncState *vs);
6163e230dd2SCorentin Chary 
617148954faSCorentin Chary int vnc_zrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
618148954faSCorentin Chary int vnc_zywrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
619148954faSCorentin Chary void vnc_zrle_clear(VncState *vs);
620148954faSCorentin Chary 
6212a6a4076SMarkus Armbruster #endif /* QEMU_VNC_H */
622