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>
42 #include <spice/vd_agent.h>
46 #include "spiceterm.h"
50 #define DPRINTF(x, format, ...) { \
52 printf("%s: " format "\n" , __FUNCTION__, ## __VA_ARGS__); \
56 #define MEM_SLOT_GROUP_ID 0
58 #define NOTIFY_DISPLAY_BATCH (SINGLE_PART/2)
59 #define NOTIFY_CURSOR_BATCH 10
61 /* these colours are from linux kernel drivers/char/vt.c */
62 /* the default colour table, for VGA+ colour systems */
63 int default_red
[] = {0x00,0xaa,0x00,0xaa,0x00,0xaa,0x00,0xaa,
64 0x55,0xff,0x55,0xff,0x55,0xff,0x55,0xff};
65 int default_grn
[] = {0x00,0x00,0xaa,0x55,0x00,0x00,0xaa,0xaa,
66 0x55,0x55,0xff,0xff,0x55,0x55,0xff,0xff};
67 int default_blu
[] = {0x00,0x00,0x00,0x00,0xaa,0xaa,0xaa,0xaa,
68 0x55,0x55,0x55,0x55,0xff,0xff,0xff,0xff};
70 /* Parts cribbed from spice-display.h/.c/qxl.c */
72 typedef struct SimpleSpiceUpdate
{
73 QXLCommandExt ext
; // first
80 spice_screen_destroy_update(SimpleSpiceUpdate
*update
)
85 if (update
->drawable
.clip
.type
!= SPICE_CLIP_TYPE_NONE
) {
86 uint8_t *ptr
= (uint8_t*)update
->drawable
.clip
.data
;
89 g_free(update
->bitmap
);
93 static int unique
= 0x0ffff + 1;
96 set_cmd(QXLCommandExt
*ext
, uint32_t type
, QXLPHYSICAL data
)
100 ext
->cmd
.padding
= 0;
101 ext
->group_id
= MEM_SLOT_GROUP_ID
;
106 simple_set_release_info(QXLReleaseInfo
*info
, intptr_t ptr
)
109 //info->group_id = MEM_SLOT_GROUP_ID;
112 /* Note: push_command/get_command are called from different threads */
115 push_command(SpiceScreen
*spice_screen
, QXLCommandExt
*ext
)
117 g_mutex_lock(spice_screen
->command_mutex
);
119 while (spice_screen
->commands_end
- spice_screen
->commands_start
>= COMMANDS_SIZE
) {
120 g_cond_wait(spice_screen
->command_cond
, spice_screen
->command_mutex
);
123 g_assert(spice_screen
->commands_end
- spice_screen
->commands_start
< COMMANDS_SIZE
);
125 spice_screen
->commands
[spice_screen
->commands_end
% COMMANDS_SIZE
] = ext
;
126 spice_screen
->commands_end
++;
128 g_mutex_unlock(spice_screen
->command_mutex
);
130 spice_screen
->qxl_worker
->wakeup(spice_screen
->qxl_worker
);
133 /* bitmap are freed, so they must be allocated with g_malloc */
134 static SimpleSpiceUpdate
*
135 spice_screen_update_from_bitmap_cmd(uint32_t surface_id
, QXLRect bbox
, uint8_t *bitmap
, int cache_id
)
137 SimpleSpiceUpdate
*update
;
138 QXLDrawable
*drawable
;
142 bh
= bbox
.bottom
- bbox
.top
;
143 bw
= bbox
.right
- bbox
.left
;
145 update
= g_new0(SimpleSpiceUpdate
, 1);
146 update
->bitmap
= bitmap
;
147 drawable
= &update
->drawable
;
148 image
= &update
->image
;
150 drawable
->surface_id
= surface_id
;
152 drawable
->bbox
= bbox
;
153 drawable
->clip
.type
= SPICE_CLIP_TYPE_NONE
;
154 drawable
->effect
= QXL_EFFECT_OPAQUE
;
155 simple_set_release_info(&drawable
->release_info
, (intptr_t)update
);
156 drawable
->type
= QXL_DRAW_COPY
;
157 drawable
->surfaces_dest
[0] = -1;
158 drawable
->surfaces_dest
[1] = -1;
159 drawable
->surfaces_dest
[2] = -1;
161 drawable
->u
.copy
.rop_descriptor
= SPICE_ROPD_OP_PUT
;
162 drawable
->u
.copy
.src_bitmap
= (intptr_t)image
;
163 drawable
->u
.copy
.src_area
.right
= bw
;
164 drawable
->u
.copy
.src_area
.bottom
= bh
;
167 QXL_SET_IMAGE_ID(image
, QXL_IMAGE_GROUP_DEVICE
, cache_id
);
169 QXL_SET_IMAGE_ID(image
, QXL_IMAGE_GROUP_DEVICE
, ++unique
);
171 image
->descriptor
.type
= SPICE_IMAGE_TYPE_BITMAP
;
172 image
->bitmap
.flags
= QXL_BITMAP_DIRECT
| QXL_BITMAP_TOP_DOWN
;
173 image
->bitmap
.stride
= bw
* 4;
174 image
->descriptor
.width
= image
->bitmap
.x
= bw
;
175 image
->descriptor
.height
= image
->bitmap
.y
= bh
;
176 image
->bitmap
.data
= (intptr_t)bitmap
;
177 image
->bitmap
.palette
= 0;
178 image
->bitmap
.format
= SPICE_BITMAP_FMT_32BIT
;
180 set_cmd(&update
->ext
, QXL_CMD_DRAW
, (intptr_t)drawable
);
185 static SimpleSpiceUpdate
*
186 spice_screen_draw_char_cmd(SpiceScreen
*spice_screen
, int x
, int y
, int c
,
187 int fg
, int bg
, gboolean uline
)
197 if (!uline
&& c
< 256) {
198 cache_id
= ((fg
<< 12) | (bg
<< 8) | (c
& 255)) & 0x0ffff;
207 bitmap
= dst
= g_malloc(bw
* bh
* 4);
209 unsigned char *data
= vt_font_data
+ c
*16;
210 unsigned char d
= *data
;
212 g_assert(fg
>= 0 && fg
< 16);
213 g_assert(bg
>= 0 && bg
< 16);
215 unsigned char fgc_red
= default_red
[fg
];
216 unsigned char fgc_blue
= default_blu
[fg
];
217 unsigned char fgc_green
= default_grn
[fg
];
218 unsigned char bgc_red
= default_red
[bg
];
219 unsigned char bgc_blue
= default_blu
[bg
];
220 unsigned char bgc_green
= default_grn
[bg
];
222 for (j
= 0; j
< 16; j
++) {
223 gboolean ul
= (j
== 14) && uline
;
224 for (i
= 0; i
< 8; i
++) {
231 *(dst
+1) = fgc_green
;
236 *(dst
+1) = bgc_green
;
245 bbox
.left
= left
; bbox
.top
= top
;
246 bbox
.right
= left
+ bw
; bbox
.bottom
= top
+ bh
;
248 return spice_screen_update_from_bitmap_cmd(0, bbox
, bitmap
, cache_id
);
252 spice_screen_scroll(SpiceScreen
*spice_screen
, int x1
, int y1
,
253 int x2
, int y2
, int src_x
, int src_y
)
255 SimpleSpiceUpdate
*update
;
256 QXLDrawable
*drawable
;
261 update
= g_new0(SimpleSpiceUpdate
, 1);
262 drawable
= &update
->drawable
;
269 drawable
->surface_id
= surface_id
;
271 drawable
->bbox
= bbox
;
272 drawable
->clip
.type
= SPICE_CLIP_TYPE_NONE
;
273 drawable
->effect
= QXL_EFFECT_OPAQUE
;
274 simple_set_release_info(&drawable
->release_info
, (intptr_t)update
);
275 drawable
->type
= QXL_COPY_BITS
;
276 drawable
->surfaces_dest
[0] = -1;
277 drawable
->surfaces_dest
[1] = -1;
278 drawable
->surfaces_dest
[2] = -1;
280 drawable
->u
.copy_bits
.src_pos
.x
= src_x
;
281 drawable
->u
.copy_bits
.src_pos
.y
= src_y
;
283 set_cmd(&update
->ext
, QXL_CMD_DRAW
, (intptr_t)drawable
);
285 push_command(spice_screen
, &update
->ext
);
289 spice_screen_clear(SpiceScreen
*spice_screen
, int x1
, int y1
, int x2
, int y2
)
291 SimpleSpiceUpdate
*update
;
292 QXLDrawable
*drawable
;
297 update
= g_new0(SimpleSpiceUpdate
, 1);
298 drawable
= &update
->drawable
;
305 drawable
->surface_id
= surface_id
;
307 drawable
->bbox
= bbox
;
308 drawable
->clip
.type
= SPICE_CLIP_TYPE_NONE
;
309 drawable
->effect
= QXL_EFFECT_OPAQUE
;
310 simple_set_release_info(&drawable
->release_info
, (intptr_t)update
);
311 drawable
->type
= QXL_DRAW_BLACKNESS
;
312 drawable
->surfaces_dest
[0] = -1;
313 drawable
->surfaces_dest
[1] = -1;
314 drawable
->surfaces_dest
[2] = -1;
316 set_cmd(&update
->ext
, QXL_CMD_DRAW
, (intptr_t)drawable
);
318 push_command(spice_screen
, &update
->ext
);
322 create_primary_surface(SpiceScreen
*spice_screen
, uint32_t width
,
325 QXLWorker
*qxl_worker
= spice_screen
->qxl_worker
;
326 QXLDevSurfaceCreate surface
= { 0, };
328 g_assert(height
<= MAX_HEIGHT
);
329 g_assert(width
<= MAX_WIDTH
);
330 g_assert(height
> 0);
333 surface
.format
= SPICE_SURFACE_FMT_32_xRGB
;
334 surface
.width
= spice_screen
->primary_width
= width
;
335 surface
.height
= spice_screen
->primary_height
= height
;
336 surface
.stride
= -width
* 4; /* negative? */
337 surface
.mouse_mode
= TRUE
; /* unused by red_worker */
339 surface
.type
= 0; /* unused by red_worker */
340 surface
.position
= 0; /* unused by red_worker */
341 surface
.mem
= (uint64_t)&spice_screen
->primary_surface
;
342 surface
.group_id
= MEM_SLOT_GROUP_ID
;
344 spice_screen
->width
= width
;
345 spice_screen
->height
= height
;
347 qxl_worker
->create_primary_surface(qxl_worker
, 0, &surface
);
351 spice_screen_resize(SpiceScreen
*spice_screen
, uint32_t width
,
354 QXLWorker
*qxl_worker
= spice_screen
->qxl_worker
;
356 if (spice_screen
->width
== width
&& spice_screen
->height
== height
) {
360 qxl_worker
->destroy_primary_surface(qxl_worker
, 0);
362 create_primary_surface(spice_screen
, width
, height
);
366 QXLDevMemSlot slot
= {
367 .slot_group_id
= MEM_SLOT_GROUP_ID
,
377 attache_worker(QXLInstance
*qin
, QXLWorker
*_qxl_worker
)
379 SpiceScreen
*spice_screen
= SPICE_CONTAINEROF(qin
, SpiceScreen
, qxl_instance
);
381 if (spice_screen
->qxl_worker
) {
382 g_assert_not_reached();
385 spice_screen
->qxl_worker
= _qxl_worker
;
386 spice_screen
->qxl_worker
->add_memslot(spice_screen
->qxl_worker
, &slot
);
387 create_primary_surface(spice_screen
, spice_screen
->width
, spice_screen
->height
);
388 spice_screen
->qxl_worker
->start(spice_screen
->qxl_worker
);
392 set_compression_level(QXLInstance
*qin
, int level
)
398 set_mm_time(QXLInstance
*qin
, uint32_t mm_time
)
404 get_init_info(QXLInstance
*qin
, QXLDevInitInfo
*info
)
406 memset(info
, 0, sizeof(*info
));
407 info
->num_memslots
= 1;
408 info
->num_memslots_groups
= 1;
409 info
->memslot_id_bits
= 1;
410 info
->memslot_gen_bits
= 1;
411 info
->n_surfaces
= 1;
414 /* called from spice_server thread (i.e. red_worker thread) */
416 get_command(QXLInstance
*qin
, struct QXLCommandExt
*ext
)
418 SpiceScreen
*spice_screen
= SPICE_CONTAINEROF(qin
, SpiceScreen
, qxl_instance
);
421 g_mutex_lock(spice_screen
->command_mutex
);
423 if ((spice_screen
->commands_end
- spice_screen
->commands_start
) == 0) {
428 *ext
= *spice_screen
->commands
[spice_screen
->commands_start
% COMMANDS_SIZE
];
429 g_assert(spice_screen
->commands_start
< spice_screen
->commands_end
);
430 spice_screen
->commands_start
++;
431 g_cond_signal(spice_screen
->command_cond
);
436 g_mutex_unlock(spice_screen
->command_mutex
);
441 req_cmd_notification(QXLInstance
*qin
)
443 //SpiceScreen *spice_screen = SPICE_CONTAINEROF(qin, SpiceScreen, qxl_instance);
444 //spice_screen->core->timer_start(spice_screen->wakeup_timer, spice_screen->wakeup_ms);
450 release_resource(QXLInstance
*qin
, struct QXLReleaseInfoExt release_info
)
452 QXLCommandExt
*ext
= (QXLCommandExt
*)(unsigned long)release_info
.info
->id
;
454 g_assert(release_info
.group_id
== MEM_SLOT_GROUP_ID
);
455 switch (ext
->cmd
.type
) {
457 spice_screen_destroy_update((void*)ext
);
459 case QXL_CMD_SURFACE
:
462 case QXL_CMD_CURSOR
: {
463 QXLCursorCmd
*cmd
= (QXLCursorCmd
*)(unsigned long)ext
->cmd
.data
;
464 if (cmd
->type
== QXL_CURSOR_SET
) {
475 #define CURSOR_WIDTH 8
476 #define CURSOR_HEIGHT 16
480 uint8_t data
[CURSOR_WIDTH
* CURSOR_HEIGHT
* 4]; // 32bit per pixel
486 cursor
.cursor
.header
.unique
= 0;
487 cursor
.cursor
.header
.type
= SPICE_CURSOR_TYPE_COLOR32
;
488 cursor
.cursor
.header
.width
= CURSOR_WIDTH
;
489 cursor
.cursor
.header
.height
= CURSOR_HEIGHT
;
490 cursor
.cursor
.header
.hot_spot_x
= 0;
491 cursor
.cursor
.header
.hot_spot_y
= 0;
492 cursor
.cursor
.data_size
= CURSOR_WIDTH
* CURSOR_HEIGHT
* 4;
494 // X drivers addes it to the cursor size because it could be
495 // cursor data information or another cursor related stuffs.
496 // Otherwise, the code will break in client/cursor.cpp side,
497 // that expect the data_size plus cursor information.
498 // Blame cursor protocol for this. :-)
499 cursor
.cursor
.data_size
+= 128;
500 cursor
.cursor
.chunk
.data_size
= cursor
.cursor
.data_size
;
501 cursor
.cursor
.chunk
.prev_chunk
= cursor
.cursor
.chunk
.next_chunk
= 0;
505 get_cursor_command(QXLInstance
*qin
, struct QXLCommandExt
*ext
)
507 SpiceScreen
*spice_screen
= SPICE_CONTAINEROF(qin
, SpiceScreen
, qxl_instance
);
509 static int x
= 0, y
= 0;
510 QXLCursorCmd
*cursor_cmd
;
513 if (!spice_screen
->cursor_notify
) {
517 spice_screen
->cursor_notify
--;
518 cmd
= calloc(sizeof(QXLCommandExt
), 1);
519 cursor_cmd
= calloc(sizeof(QXLCursorCmd
), 1);
521 cursor_cmd
->release_info
.id
= (unsigned long)cmd
;
524 cursor_cmd
->type
= QXL_CURSOR_SET
;
525 cursor_cmd
->u
.set
.position
.x
= 0;
526 cursor_cmd
->u
.set
.position
.y
= 0;
527 cursor_cmd
->u
.set
.visible
= TRUE
;
528 cursor_cmd
->u
.set
.shape
= (unsigned long)&cursor
;
529 // white rect as cursor
530 memset(cursor
.data
, 255, sizeof(cursor
.data
));
533 cursor_cmd
->type
= QXL_CURSOR_MOVE
;
534 cursor_cmd
->u
.position
.x
= x
++ % spice_screen
->primary_width
;
535 cursor_cmd
->u
.position
.y
= y
++ % spice_screen
->primary_height
;
538 cmd
->cmd
.data
= (unsigned long)cursor_cmd
;
539 cmd
->cmd
.type
= QXL_CMD_CURSOR
;
540 cmd
->group_id
= MEM_SLOT_GROUP_ID
;
548 req_cursor_notification(QXLInstance
*qin
)
556 notify_update(QXLInstance
*qin
, uint32_t update_id
)
562 flush_resources(QXLInstance
*qin
)
570 client_monitors_config(QXLInstance
*qin
, VDAgentMonitorsConfig
*monitors_config
)
578 set_client_capabilities(QXLInstance
*qin
, uint8_t client_present
,
581 SpiceScreen
*spice_screen
= SPICE_CONTAINEROF(qin
, SpiceScreen
, qxl_instance
);
583 DPRINTF(1, "present %d caps %d", client_present
, caps
[0]);
585 if (spice_screen
->on_client_connected
&& client_present
) {
586 spice_screen
->on_client_connected(spice_screen
);
588 if (spice_screen
->on_client_disconnected
&& !client_present
) {
589 spice_screen
->on_client_disconnected(spice_screen
);
593 static int client_count
= 0;
596 client_connected(SpiceScreen
*spice_screen
)
600 DPRINTF(1, "client_count = %d", client_count
);
604 client_disconnected(SpiceScreen
*spice_screen
)
606 if (client_count
> 0) {
608 DPRINTF(1, "client_count = %d", client_count
);
609 exit(0); // fixme: cleanup?
614 do_conn_timeout(void *opaque
)
616 // SpiceScreen *spice_screen = opaque;
618 if (client_count
<= 0) {
619 printf("connection timeout - stopping server\n");
620 exit (0); // fixme: cleanup?
624 QXLInterface display_sif
= {
626 .type
= SPICE_INTERFACE_QXL
,
627 .description
= "spiceterm display server",
628 .major_version
= SPICE_INTERFACE_QXL_MAJOR
,
629 .minor_version
= SPICE_INTERFACE_QXL_MINOR
631 .attache_worker
= attache_worker
,
632 .set_compression_level
= set_compression_level
,
633 .set_mm_time
= set_mm_time
,
634 .get_init_info
= get_init_info
,
636 /* the callbacks below are called from spice server thread context */
637 .get_command
= get_command
,
638 .req_cmd_notification
= req_cmd_notification
,
639 .release_resource
= release_resource
,
640 .get_cursor_command
= get_cursor_command
,
641 .req_cursor_notification
= req_cursor_notification
,
642 .notify_update
= notify_update
,
643 .flush_resources
= flush_resources
,
644 .client_monitors_config
= client_monitors_config
,
645 .set_client_capabilities
= set_client_capabilities
,
650 spice_screen_draw_char(SpiceScreen
*spice_screen
, int x
, int y
, gunichar2 ch
,
651 TextAttributes attrib
)
657 invers
= attrib
.selected
? 0 : 1;
659 invers
= attrib
.selected
? 1 : 0;
674 // unsuported attributes = (attrib.blink || attrib.unvisible)
676 int c
= vt_fontmap
[ch
];
678 SimpleSpiceUpdate
*update
;
679 update
= spice_screen_draw_char_cmd(spice_screen
, x
, y
, c
, fg
, bg
, attrib
.uline
);
680 push_command(spice_screen
, &update
->ext
);
684 spice_screen_new(SpiceCoreInterface
*core
, uint32_t width
, uint32_t height
, guint timeout
)
687 SpiceScreen
*spice_screen
= g_new0(SpiceScreen
, 1);
688 SpiceServer
* server
= spice_server_new();
690 spice_screen
->width
= width
;
691 spice_screen
->height
= height
;
693 spice_screen
->command_cond
= g_cond_new();
694 spice_screen
->command_mutex
= g_mutex_new();
696 spice_screen
->on_client_connected
= client_connected
,
697 spice_screen
->on_client_disconnected
= client_disconnected
,
699 spice_screen
->qxl_instance
.base
.sif
= &display_sif
.base
;
700 spice_screen
->qxl_instance
.id
= 0;
702 spice_screen
->core
= core
;
703 spice_screen
->server
= server
;
705 spice_screen
->cursor_notify
= NOTIFY_CURSOR_BATCH
;
707 printf("listening on port %d (unsecure)\n", port
);
709 spice_server_set_port(server
, port
);
710 spice_server_set_noauth(server
);
712 int res
= spice_server_init(server
, core
);
714 g_error("spice_server_init failed, res = %d\n", res
);
719 spice_screen
->conn_timeout_timer
= core
->timer_add(do_conn_timeout
, spice_screen
);
720 spice_screen
->core
->timer_start(spice_screen
->conn_timeout_timer
, timeout
*1000);
722 spice_server_add_interface(spice_screen
->server
, &spice_screen
->qxl_instance
.base
);