3 Copyright (C) 2013 Proxmox Server Solutions GmbH
5 Copyright: spiceterm is under GNU GPL, the GNU General Public License.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; version 2 dated June, 1991.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
21 Author: Dietmar Maurer <dietmar@proxmox.com>
23 Note: qlx drawing code is copied from spice-server test code.
34 #include <sys/select.h>
35 #include <sys/types.h>
39 #include <spice/enums.h>
40 #include <spice/macros.h>
41 #include <spice/qxl_dev.h>
45 #include "spiceterm.h"
49 #define DPRINTF(x, format, ...) { \
51 printf("%s: " format "\n" , __FUNCTION__, ## __VA_ARGS__); \
55 #define MEM_SLOT_GROUP_ID 0
57 #define NOTIFY_DISPLAY_BATCH (SINGLE_PART/2)
58 #define NOTIFY_CURSOR_BATCH 10
60 /* these colours are from linux kernel drivers/char/vt.c */
61 /* the default colour table, for VGA+ colour systems */
62 int default_red
[] = {0x00,0xaa,0x00,0xaa,0x00,0xaa,0x00,0xaa,
63 0x55,0xff,0x55,0xff,0x55,0xff,0x55,0xff};
64 int default_grn
[] = {0x00,0x00,0xaa,0x55,0x00,0x00,0xaa,0xaa,
65 0x55,0x55,0xff,0xff,0x55,0x55,0xff,0xff};
66 int default_blu
[] = {0x00,0x00,0x00,0x00,0xaa,0xaa,0xaa,0xaa,
67 0x55,0x55,0x55,0x55,0xff,0xff,0xff,0xff};
69 /* Parts cribbed from spice-display.h/.c/qxl.c */
71 typedef struct SimpleSpiceUpdate
{
72 QXLCommandExt ext
; // first
79 spice_screen_destroy_update(SimpleSpiceUpdate
*update
)
84 if (update
->drawable
.clip
.type
!= SPICE_CLIP_TYPE_NONE
) {
85 uint8_t *ptr
= (uint8_t*)update
->drawable
.clip
.data
;
88 g_free(update
->bitmap
);
92 #define DEFAULT_WIDTH 640
93 #define DEFAULT_HEIGHT 320
95 static int unique
= 0x0ffff + 1;
98 set_cmd(QXLCommandExt
*ext
, uint32_t type
, QXLPHYSICAL data
)
100 ext
->cmd
.type
= type
;
101 ext
->cmd
.data
= data
;
102 ext
->cmd
.padding
= 0;
103 ext
->group_id
= MEM_SLOT_GROUP_ID
;
108 simple_set_release_info(QXLReleaseInfo
*info
, intptr_t ptr
)
111 //info->group_id = MEM_SLOT_GROUP_ID;
114 /* Note: push_command/get_command are called from different threads */
117 push_command(SpiceScreen
*spice_screen
, QXLCommandExt
*ext
)
119 g_mutex_lock(spice_screen
->command_mutex
);
121 while (spice_screen
->commands_end
- spice_screen
->commands_start
>= COMMANDS_SIZE
) {
122 g_cond_wait(spice_screen
->command_cond
, spice_screen
->command_mutex
);
125 g_assert(spice_screen
->commands_end
- spice_screen
->commands_start
< COMMANDS_SIZE
);
127 spice_screen
->commands
[spice_screen
->commands_end
% COMMANDS_SIZE
] = ext
;
128 spice_screen
->commands_end
++;
130 g_mutex_unlock(spice_screen
->command_mutex
);
132 spice_screen
->qxl_worker
->wakeup(spice_screen
->qxl_worker
);
135 /* bitmap are freed, so they must be allocated with g_malloc */
136 static SimpleSpiceUpdate
*
137 spice_screen_update_from_bitmap_cmd(uint32_t surface_id
, QXLRect bbox
, uint8_t *bitmap
, int cache_id
)
139 SimpleSpiceUpdate
*update
;
140 QXLDrawable
*drawable
;
144 bh
= bbox
.bottom
- bbox
.top
;
145 bw
= bbox
.right
- bbox
.left
;
147 update
= g_new0(SimpleSpiceUpdate
, 1);
148 update
->bitmap
= bitmap
;
149 drawable
= &update
->drawable
;
150 image
= &update
->image
;
152 drawable
->surface_id
= surface_id
;
154 drawable
->bbox
= bbox
;
155 drawable
->clip
.type
= SPICE_CLIP_TYPE_NONE
;
156 drawable
->effect
= QXL_EFFECT_OPAQUE
;
157 simple_set_release_info(&drawable
->release_info
, (intptr_t)update
);
158 drawable
->type
= QXL_DRAW_COPY
;
159 drawable
->surfaces_dest
[0] = -1;
160 drawable
->surfaces_dest
[1] = -1;
161 drawable
->surfaces_dest
[2] = -1;
163 drawable
->u
.copy
.rop_descriptor
= SPICE_ROPD_OP_PUT
;
164 drawable
->u
.copy
.src_bitmap
= (intptr_t)image
;
165 drawable
->u
.copy
.src_area
.right
= bw
;
166 drawable
->u
.copy
.src_area
.bottom
= bh
;
169 QXL_SET_IMAGE_ID(image
, QXL_IMAGE_GROUP_DEVICE
, cache_id
);
171 QXL_SET_IMAGE_ID(image
, QXL_IMAGE_GROUP_DEVICE
, ++unique
);
173 image
->descriptor
.type
= SPICE_IMAGE_TYPE_BITMAP
;
174 image
->bitmap
.flags
= QXL_BITMAP_DIRECT
| QXL_BITMAP_TOP_DOWN
;
175 image
->bitmap
.stride
= bw
* 4;
176 image
->descriptor
.width
= image
->bitmap
.x
= bw
;
177 image
->descriptor
.height
= image
->bitmap
.y
= bh
;
178 image
->bitmap
.data
= (intptr_t)bitmap
;
179 image
->bitmap
.palette
= 0;
180 image
->bitmap
.format
= SPICE_BITMAP_FMT_32BIT
;
182 set_cmd(&update
->ext
, QXL_CMD_DRAW
, (intptr_t)drawable
);
187 static SimpleSpiceUpdate
*
188 spice_screen_draw_char_cmd(SpiceScreen
*spice_screen
, int x
, int y
, int c
,
189 int fg
, int bg
, gboolean uline
)
199 if (!uline
&& c
< 256) {
200 cache_id
= ((fg
<< 12) | (bg
<< 8) | (c
& 255)) & 0x0ffff;
209 bitmap
= dst
= g_malloc(bw
* bh
* 4);
211 unsigned char *data
= vt_font_data
+ c
*16;
212 unsigned char d
= *data
;
214 g_assert(fg
>= 0 && fg
< 16);
215 g_assert(bg
>= 0 && bg
< 16);
217 unsigned char fgc_red
= default_red
[fg
];
218 unsigned char fgc_blue
= default_blu
[fg
];
219 unsigned char fgc_green
= default_grn
[fg
];
220 unsigned char bgc_red
= default_red
[bg
];
221 unsigned char bgc_blue
= default_blu
[bg
];
222 unsigned char bgc_green
= default_grn
[bg
];
224 for (j
= 0; j
< 16; j
++) {
225 gboolean ul
= (j
== 14) && uline
;
226 for (i
= 0; i
< 8; i
++) {
233 *(dst
+1) = fgc_green
;
238 *(dst
+1) = bgc_green
;
247 bbox
.left
= left
; bbox
.top
= top
;
248 bbox
.right
= left
+ bw
; bbox
.bottom
= top
+ bh
;
250 return spice_screen_update_from_bitmap_cmd(0, bbox
, bitmap
, cache_id
);
254 spice_screen_scroll(SpiceScreen
*spice_screen
, int x1
, int y1
,
255 int x2
, int y2
, int src_x
, int src_y
)
257 SimpleSpiceUpdate
*update
;
258 QXLDrawable
*drawable
;
263 update
= g_new0(SimpleSpiceUpdate
, 1);
264 drawable
= &update
->drawable
;
271 drawable
->surface_id
= surface_id
;
273 drawable
->bbox
= bbox
;
274 drawable
->clip
.type
= SPICE_CLIP_TYPE_NONE
;
275 drawable
->effect
= QXL_EFFECT_OPAQUE
;
276 simple_set_release_info(&drawable
->release_info
, (intptr_t)update
);
277 drawable
->type
= QXL_COPY_BITS
;
278 drawable
->surfaces_dest
[0] = -1;
279 drawable
->surfaces_dest
[1] = -1;
280 drawable
->surfaces_dest
[2] = -1;
282 drawable
->u
.copy_bits
.src_pos
.x
= src_x
;
283 drawable
->u
.copy_bits
.src_pos
.y
= src_y
;
285 set_cmd(&update
->ext
, QXL_CMD_DRAW
, (intptr_t)drawable
);
287 push_command(spice_screen
, &update
->ext
);
291 spice_screen_clear(SpiceScreen
*spice_screen
, int x1
, int y1
, int x2
, int y2
)
293 SimpleSpiceUpdate
*update
;
294 QXLDrawable
*drawable
;
299 update
= g_new0(SimpleSpiceUpdate
, 1);
300 drawable
= &update
->drawable
;
307 drawable
->surface_id
= surface_id
;
309 drawable
->bbox
= bbox
;
310 drawable
->clip
.type
= SPICE_CLIP_TYPE_NONE
;
311 drawable
->effect
= QXL_EFFECT_OPAQUE
;
312 simple_set_release_info(&drawable
->release_info
, (intptr_t)update
);
313 drawable
->type
= QXL_DRAW_BLACKNESS
;
314 drawable
->surfaces_dest
[0] = -1;
315 drawable
->surfaces_dest
[1] = -1;
316 drawable
->surfaces_dest
[2] = -1;
318 set_cmd(&update
->ext
, QXL_CMD_DRAW
, (intptr_t)drawable
);
320 push_command(spice_screen
, &update
->ext
);
324 create_primary_surface(SpiceScreen
*spice_screen
, uint32_t width
,
327 QXLWorker
*qxl_worker
= spice_screen
->qxl_worker
;
328 QXLDevSurfaceCreate surface
= { 0, };
330 g_assert(height
<= MAX_HEIGHT
);
331 g_assert(width
<= MAX_WIDTH
);
332 g_assert(height
> 0);
335 surface
.format
= SPICE_SURFACE_FMT_32_xRGB
;
336 surface
.width
= spice_screen
->primary_width
= width
;
337 surface
.height
= spice_screen
->primary_height
= height
;
338 surface
.stride
= -width
* 4; /* negative? */
339 surface
.mouse_mode
= TRUE
; /* unused by red_worker */
341 surface
.type
= 0; /* unused by red_worker */
342 surface
.position
= 0; /* unused by red_worker */
343 surface
.mem
= (uint64_t)&spice_screen
->primary_surface
;
344 surface
.group_id
= MEM_SLOT_GROUP_ID
;
346 spice_screen
->width
= width
;
347 spice_screen
->height
= height
;
349 qxl_worker
->create_primary_surface(qxl_worker
, 0, &surface
);
352 QXLDevMemSlot slot
= {
353 .slot_group_id
= MEM_SLOT_GROUP_ID
,
363 attache_worker(QXLInstance
*qin
, QXLWorker
*_qxl_worker
)
365 SpiceScreen
*spice_screen
= SPICE_CONTAINEROF(qin
, SpiceScreen
, qxl_instance
);
367 if (spice_screen
->qxl_worker
) {
368 g_assert_not_reached();
371 spice_screen
->qxl_worker
= _qxl_worker
;
372 spice_screen
->qxl_worker
->add_memslot(spice_screen
->qxl_worker
, &slot
);
373 create_primary_surface(spice_screen
, DEFAULT_WIDTH
, DEFAULT_HEIGHT
);
374 spice_screen
->qxl_worker
->start(spice_screen
->qxl_worker
);
378 set_compression_level(QXLInstance
*qin
, int level
)
384 set_mm_time(QXLInstance
*qin
, uint32_t mm_time
)
390 get_init_info(QXLInstance
*qin
, QXLDevInitInfo
*info
)
392 memset(info
, 0, sizeof(*info
));
393 info
->num_memslots
= 1;
394 info
->num_memslots_groups
= 1;
395 info
->memslot_id_bits
= 1;
396 info
->memslot_gen_bits
= 1;
397 info
->n_surfaces
= 1;
400 /* called from spice_server thread (i.e. red_worker thread) */
402 get_command(QXLInstance
*qin
, struct QXLCommandExt
*ext
)
404 SpiceScreen
*spice_screen
= SPICE_CONTAINEROF(qin
, SpiceScreen
, qxl_instance
);
407 g_mutex_lock(spice_screen
->command_mutex
);
409 if ((spice_screen
->commands_end
- spice_screen
->commands_start
) == 0) {
414 *ext
= *spice_screen
->commands
[spice_screen
->commands_start
% COMMANDS_SIZE
];
415 g_assert(spice_screen
->commands_start
< spice_screen
->commands_end
);
416 spice_screen
->commands_start
++;
417 g_cond_signal(spice_screen
->command_cond
);
422 g_mutex_unlock(spice_screen
->command_mutex
);
427 req_cmd_notification(QXLInstance
*qin
)
429 //SpiceScreen *spice_screen = SPICE_CONTAINEROF(qin, SpiceScreen, qxl_instance);
430 //spice_screen->core->timer_start(spice_screen->wakeup_timer, spice_screen->wakeup_ms);
436 release_resource(QXLInstance
*qin
, struct QXLReleaseInfoExt release_info
)
438 QXLCommandExt
*ext
= (QXLCommandExt
*)(unsigned long)release_info
.info
->id
;
440 g_assert(release_info
.group_id
== MEM_SLOT_GROUP_ID
);
441 switch (ext
->cmd
.type
) {
443 spice_screen_destroy_update((void*)ext
);
445 case QXL_CMD_SURFACE
:
448 case QXL_CMD_CURSOR
: {
449 QXLCursorCmd
*cmd
= (QXLCursorCmd
*)(unsigned long)ext
->cmd
.data
;
450 if (cmd
->type
== QXL_CURSOR_SET
) {
461 #define CURSOR_WIDTH 8
462 #define CURSOR_HEIGHT 16
466 uint8_t data
[CURSOR_WIDTH
* CURSOR_HEIGHT
* 4]; // 32bit per pixel
472 cursor
.cursor
.header
.unique
= 0;
473 cursor
.cursor
.header
.type
= SPICE_CURSOR_TYPE_COLOR32
;
474 cursor
.cursor
.header
.width
= CURSOR_WIDTH
;
475 cursor
.cursor
.header
.height
= CURSOR_HEIGHT
;
476 cursor
.cursor
.header
.hot_spot_x
= 0;
477 cursor
.cursor
.header
.hot_spot_y
= 0;
478 cursor
.cursor
.data_size
= CURSOR_WIDTH
* CURSOR_HEIGHT
* 4;
480 // X drivers addes it to the cursor size because it could be
481 // cursor data information or another cursor related stuffs.
482 // Otherwise, the code will break in client/cursor.cpp side,
483 // that expect the data_size plus cursor information.
484 // Blame cursor protocol for this. :-)
485 cursor
.cursor
.data_size
+= 128;
486 cursor
.cursor
.chunk
.data_size
= cursor
.cursor
.data_size
;
487 cursor
.cursor
.chunk
.prev_chunk
= cursor
.cursor
.chunk
.next_chunk
= 0;
491 get_cursor_command(QXLInstance
*qin
, struct QXLCommandExt
*ext
)
493 SpiceScreen
*spice_screen
= SPICE_CONTAINEROF(qin
, SpiceScreen
, qxl_instance
);
495 static int x
= 0, y
= 0;
496 QXLCursorCmd
*cursor_cmd
;
499 if (!spice_screen
->cursor_notify
) {
503 spice_screen
->cursor_notify
--;
504 cmd
= calloc(sizeof(QXLCommandExt
), 1);
505 cursor_cmd
= calloc(sizeof(QXLCursorCmd
), 1);
507 cursor_cmd
->release_info
.id
= (unsigned long)cmd
;
510 cursor_cmd
->type
= QXL_CURSOR_SET
;
511 cursor_cmd
->u
.set
.position
.x
= 0;
512 cursor_cmd
->u
.set
.position
.y
= 0;
513 cursor_cmd
->u
.set
.visible
= TRUE
;
514 cursor_cmd
->u
.set
.shape
= (unsigned long)&cursor
;
515 // white rect as cursor
516 memset(cursor
.data
, 255, sizeof(cursor
.data
));
519 cursor_cmd
->type
= QXL_CURSOR_MOVE
;
520 cursor_cmd
->u
.position
.x
= x
++ % spice_screen
->primary_width
;
521 cursor_cmd
->u
.position
.y
= y
++ % spice_screen
->primary_height
;
524 cmd
->cmd
.data
= (unsigned long)cursor_cmd
;
525 cmd
->cmd
.type
= QXL_CMD_CURSOR
;
526 cmd
->group_id
= MEM_SLOT_GROUP_ID
;
534 req_cursor_notification(QXLInstance
*qin
)
542 notify_update(QXLInstance
*qin
, uint32_t update_id
)
548 flush_resources(QXLInstance
*qin
)
556 client_monitors_config(QXLInstance
*qin
, VDAgentMonitorsConfig
*monitors_config
)
564 set_client_capabilities(QXLInstance
*qin
, uint8_t client_present
,
567 SpiceScreen
*spice_screen
= SPICE_CONTAINEROF(qin
, SpiceScreen
, qxl_instance
);
569 DPRINTF(1, "present %d caps %d", client_present
, caps
[0]);
571 if (spice_screen
->on_client_connected
&& client_present
) {
572 spice_screen
->on_client_connected(spice_screen
);
574 if (spice_screen
->on_client_disconnected
&& !client_present
) {
575 spice_screen
->on_client_disconnected(spice_screen
);
579 static int client_count
= 0;
582 client_connected(SpiceScreen
*spice_screen
)
586 DPRINTF(1, "client_count = %d", client_count
);
590 client_disconnected(SpiceScreen
*spice_screen
)
592 if (client_count
> 0) {
594 DPRINTF(1, "client_count = %d", client_count
);
595 exit(0); // fixme: cleanup?
600 do_conn_timeout(void *opaque
)
602 // SpiceScreen *spice_screen = opaque;
604 if (client_count
<= 0) {
605 printf("connection timeout - stopping server\n");
606 exit (0); // fixme: cleanup?
610 QXLInterface display_sif
= {
612 .type
= SPICE_INTERFACE_QXL
,
613 .description
= "spiceterm display server",
614 .major_version
= SPICE_INTERFACE_QXL_MAJOR
,
615 .minor_version
= SPICE_INTERFACE_QXL_MINOR
617 .attache_worker
= attache_worker
,
618 .set_compression_level
= set_compression_level
,
619 .set_mm_time
= set_mm_time
,
620 .get_init_info
= get_init_info
,
622 /* the callbacks below are called from spice server thread context */
623 .get_command
= get_command
,
624 .req_cmd_notification
= req_cmd_notification
,
625 .release_resource
= release_resource
,
626 .get_cursor_command
= get_cursor_command
,
627 .req_cursor_notification
= req_cursor_notification
,
628 .notify_update
= notify_update
,
629 .flush_resources
= flush_resources
,
630 .client_monitors_config
= client_monitors_config
,
631 .set_client_capabilities
= set_client_capabilities
,
634 /* vdagent interface - not sure why we need that? */
636 vmc_write(SpiceCharDeviceInstance
*sin
, const uint8_t *buf
, int len
)
642 vmc_read(SpiceCharDeviceInstance
*sin
, uint8_t *buf
, int len
)
648 vmc_state(SpiceCharDeviceInstance
*sin
, int connected
)
653 static SpiceCharDeviceInterface vdagent_sif
= {
654 .base
.type
= SPICE_INTERFACE_CHAR_DEVICE
,
655 .base
.description
= "spice virtual channel char device",
656 .base
.major_version
= SPICE_INTERFACE_CHAR_DEVICE_MAJOR
,
657 .base
.minor_version
= SPICE_INTERFACE_CHAR_DEVICE_MINOR
,
663 SpiceCharDeviceInstance vdagent_sin
= {
665 .sif
= &vdagent_sif
.base
,
667 .subtype
= "vdagent",
671 spice_screen_draw_char(SpiceScreen
*spice_screen
, int x
, int y
, gunichar2 ch
, TextAttributes attrib
)
687 // unsuported attributes = (attrib.blink || attrib.unvisible)
689 int c
= vt_fontmap
[ch
];
691 SimpleSpiceUpdate
*update
;
692 update
= spice_screen_draw_char_cmd(spice_screen
, x
, y
, c
, fg
, bg
, attrib
.uline
);
693 push_command(spice_screen
, &update
->ext
);
697 spice_screen_new(SpiceCoreInterface
*core
)
700 SpiceScreen
*spice_screen
= g_new0(SpiceScreen
, 1);
701 SpiceServer
* server
= spice_server_new();
703 spice_screen
->command_cond
= g_cond_new();
704 spice_screen
->command_mutex
= g_mutex_new();
706 spice_screen
->on_client_connected
= client_connected
,
707 spice_screen
->on_client_disconnected
= client_disconnected
,
709 spice_screen
->qxl_instance
.base
.sif
= &display_sif
.base
;
710 spice_screen
->qxl_instance
.id
= 0;
712 spice_screen
->core
= core
;
713 spice_screen
->server
= server
;
715 spice_screen
->cursor_notify
= NOTIFY_CURSOR_BATCH
;
717 printf("listening on port %d (unsecure)\n", port
);
719 spice_server_set_port(server
, port
);
720 spice_server_set_noauth(server
);
722 int res
= spice_server_init(server
, core
);
724 g_error("spice_server_init failed, res = %d\n", res
);
729 int timeout
= 10; // max time to wait for client connection
730 spice_screen
->conn_timeout_timer
= core
->timer_add(do_conn_timeout
, spice_screen
);
731 spice_screen
->core
->timer_start(spice_screen
->conn_timeout_timer
, timeout
*1000);
733 spice_server_add_interface(spice_screen
->server
, &spice_screen
->qxl_instance
.base
);
735 spice_server_add_interface(server
, &vdagent_sin
.base
);