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
; // needs to be first member
77 int cache_id
; // do not free bitmap if cache_id != 0
81 spice_screen_destroy_update(SimpleSpiceUpdate
*update
)
86 if (update
->drawable
.clip
.type
!= SPICE_CLIP_TYPE_NONE
) {
87 uint8_t *ptr
= (uint8_t*)update
->drawable
.clip
.data
;
90 if (update
->bitmap
&& !update
->cache_id
) {
91 g_free(update
->bitmap
);
97 static int unique
= 0x0ffff + 1;
100 set_cmd(QXLCommandExt
*ext
, uint32_t type
, QXLPHYSICAL data
)
102 ext
->cmd
.type
= type
;
103 ext
->cmd
.data
= data
;
104 ext
->cmd
.padding
= 0;
105 ext
->group_id
= MEM_SLOT_GROUP_ID
;
110 simple_set_release_info(QXLReleaseInfo
*info
, intptr_t ptr
)
113 //info->group_id = MEM_SLOT_GROUP_ID;
116 /* Note: push_command/get_command are called from different threads */
119 push_command(SpiceScreen
*spice_screen
, QXLCommandExt
*ext
)
123 g_mutex_lock(spice_screen
->command_mutex
);
125 while (spice_screen
->commands_end
- spice_screen
->commands_start
>= COMMANDS_SIZE
) {
126 g_cond_wait(spice_screen
->command_cond
, spice_screen
->command_mutex
);
129 g_assert(spice_screen
->commands_end
- spice_screen
->commands_start
< COMMANDS_SIZE
);
131 if ((spice_screen
->commands_end
- spice_screen
->commands_start
) > 0) {
135 spice_screen
->commands
[spice_screen
->commands_end
% COMMANDS_SIZE
] = ext
;
136 spice_screen
->commands_end
++;
139 spice_screen
->qxl_worker
->wakeup(spice_screen
->qxl_worker
);
142 g_mutex_unlock(spice_screen
->command_mutex
);
146 /* bitmap are freed, so they must be allocated with g_malloc */
147 static SimpleSpiceUpdate
*
148 spice_screen_update_from_bitmap_cmd(uint32_t surface_id
, QXLRect bbox
, uint8_t *bitmap
, int cache_id
)
150 SimpleSpiceUpdate
*update
;
151 QXLDrawable
*drawable
;
155 bh
= bbox
.bottom
- bbox
.top
;
156 bw
= bbox
.right
- bbox
.left
;
158 update
= g_new0(SimpleSpiceUpdate
, 1);
159 update
->bitmap
= bitmap
;
160 drawable
= &update
->drawable
;
161 image
= &update
->image
;
163 drawable
->surface_id
= surface_id
;
165 drawable
->bbox
= bbox
;
166 drawable
->clip
.type
= SPICE_CLIP_TYPE_NONE
;
167 drawable
->effect
= QXL_EFFECT_OPAQUE
;
168 simple_set_release_info(&drawable
->release_info
, (intptr_t)update
);
169 drawable
->type
= QXL_DRAW_COPY
;
170 drawable
->surfaces_dest
[0] = -1;
171 drawable
->surfaces_dest
[1] = -1;
172 drawable
->surfaces_dest
[2] = -1;
174 drawable
->u
.copy
.rop_descriptor
= SPICE_ROPD_OP_PUT
;
175 drawable
->u
.copy
.src_bitmap
= (intptr_t)image
;
176 drawable
->u
.copy
.src_area
.right
= bw
;
177 drawable
->u
.copy
.src_area
.bottom
= bh
;
180 QXL_SET_IMAGE_ID(image
, QXL_IMAGE_GROUP_DEVICE
, cache_id
);
181 image
->descriptor
.flags
= SPICE_IMAGE_FLAGS_CACHE_ME
;
182 update
->cache_id
= cache_id
;
184 QXL_SET_IMAGE_ID(image
, QXL_IMAGE_GROUP_DEVICE
, ++unique
);
186 image
->descriptor
.type
= SPICE_IMAGE_TYPE_BITMAP
;
187 image
->bitmap
.flags
= QXL_BITMAP_DIRECT
| QXL_BITMAP_TOP_DOWN
;
188 image
->bitmap
.stride
= bw
* 4;
189 image
->descriptor
.width
= image
->bitmap
.x
= bw
;
190 image
->descriptor
.height
= image
->bitmap
.y
= bh
;
191 image
->bitmap
.data
= (intptr_t)bitmap
;
192 image
->bitmap
.palette
= 0;
193 image
->bitmap
.format
= SPICE_BITMAP_FMT_32BIT
;
195 set_cmd(&update
->ext
, QXL_CMD_DRAW
, (intptr_t)drawable
);
200 static SimpleSpiceUpdate
*
201 spice_screen_draw_char_cmd(SpiceScreen
*spice_screen
, int x
, int y
, int c
,
202 int fg
, int bg
, gboolean uline
)
206 uint8_t *bitmap
= NULL
;
213 if (!uline
&& c
< 256) {
214 cache_id
= ((fg
<< 12) | (bg
<< 8) | (c
& 255)) & 0x0ffff;
215 if ((ce
= (CachedImage
*)g_hash_table_lookup(spice_screen
->image_cache
, &cache_id
))) {
227 bitmap
= dst
= g_malloc(bw
* bh
* 4);
229 unsigned char *data
= vt_font_data
+ c
*16;
230 unsigned char d
= *data
;
232 g_assert(fg
>= 0 && fg
< 16);
233 g_assert(bg
>= 0 && bg
< 16);
235 unsigned char fgc_red
= default_red
[fg
];
236 unsigned char fgc_blue
= default_blu
[fg
];
237 unsigned char fgc_green
= default_grn
[fg
];
238 unsigned char bgc_red
= default_red
[bg
];
239 unsigned char bgc_blue
= default_blu
[bg
];
240 unsigned char bgc_green
= default_grn
[bg
];
242 for (j
= 0; j
< 16; j
++) {
243 gboolean ul
= (j
== 14) && uline
;
244 for (i
= 0; i
< 8; i
++) {
251 *(dst
+1) = fgc_green
;
256 *(dst
+1) = bgc_green
;
264 ce
= g_new(CachedImage
, 1);
265 ce
->cache_id
= cache_id
;
267 g_hash_table_insert(spice_screen
->image_cache
, &ce
->cache_id
, ce
);
270 bbox
.left
= left
; bbox
.top
= top
;
271 bbox
.right
= left
+ bw
; bbox
.bottom
= top
+ bh
;
273 return spice_screen_update_from_bitmap_cmd(0, bbox
, bitmap
, cache_id
);
277 spice_screen_scroll(SpiceScreen
*spice_screen
, int x1
, int y1
,
278 int x2
, int y2
, int src_x
, int src_y
)
280 SimpleSpiceUpdate
*update
;
281 QXLDrawable
*drawable
;
286 update
= g_new0(SimpleSpiceUpdate
, 1);
287 drawable
= &update
->drawable
;
294 drawable
->surface_id
= surface_id
;
296 drawable
->bbox
= bbox
;
297 drawable
->clip
.type
= SPICE_CLIP_TYPE_NONE
;
298 drawable
->effect
= QXL_EFFECT_OPAQUE
;
299 simple_set_release_info(&drawable
->release_info
, (intptr_t)update
);
300 drawable
->type
= QXL_COPY_BITS
;
301 drawable
->surfaces_dest
[0] = -1;
302 drawable
->surfaces_dest
[1] = -1;
303 drawable
->surfaces_dest
[2] = -1;
305 drawable
->u
.copy_bits
.src_pos
.x
= src_x
;
306 drawable
->u
.copy_bits
.src_pos
.y
= src_y
;
308 set_cmd(&update
->ext
, QXL_CMD_DRAW
, (intptr_t)drawable
);
310 push_command(spice_screen
, &update
->ext
);
314 spice_screen_clear(SpiceScreen
*spice_screen
, int x1
, int y1
, int x2
, int y2
)
316 SimpleSpiceUpdate
*update
;
317 QXLDrawable
*drawable
;
322 update
= g_new0(SimpleSpiceUpdate
, 1);
323 drawable
= &update
->drawable
;
330 drawable
->surface_id
= surface_id
;
332 drawable
->bbox
= bbox
;
333 drawable
->clip
.type
= SPICE_CLIP_TYPE_NONE
;
334 drawable
->effect
= QXL_EFFECT_OPAQUE
;
335 simple_set_release_info(&drawable
->release_info
, (intptr_t)update
);
336 drawable
->type
= QXL_DRAW_BLACKNESS
;
337 drawable
->surfaces_dest
[0] = -1;
338 drawable
->surfaces_dest
[1] = -1;
339 drawable
->surfaces_dest
[2] = -1;
341 set_cmd(&update
->ext
, QXL_CMD_DRAW
, (intptr_t)drawable
);
343 push_command(spice_screen
, &update
->ext
);
347 create_primary_surface(SpiceScreen
*spice_screen
, uint32_t width
,
350 QXLWorker
*qxl_worker
= spice_screen
->qxl_worker
;
351 QXLDevSurfaceCreate surface
= { 0, };
353 g_assert(height
> 0);
356 if (height
> MAX_HEIGHT
)
359 if (width
> MAX_WIDTH
)
362 surface
.format
= SPICE_SURFACE_FMT_32_xRGB
;
363 surface
.width
= spice_screen
->primary_width
= width
;
364 surface
.height
= spice_screen
->primary_height
= height
;
365 surface
.stride
= -width
* 4; /* negative? */
366 surface
.mouse_mode
= TRUE
; /* unused by red_worker */
368 surface
.type
= 0; /* unused by red_worker */
369 surface
.position
= 0; /* unused by red_worker */
370 surface
.mem
= (uint64_t)&spice_screen
->primary_surface
;
371 surface
.group_id
= MEM_SLOT_GROUP_ID
;
373 spice_screen
->width
= width
;
374 spice_screen
->height
= height
;
376 qxl_worker
->create_primary_surface(qxl_worker
, 0, &surface
);
380 spice_screen_resize(SpiceScreen
*spice_screen
, uint32_t width
,
383 QXLWorker
*qxl_worker
= spice_screen
->qxl_worker
;
385 if (spice_screen
->width
== width
&& spice_screen
->height
== height
) {
389 qxl_worker
->destroy_primary_surface(qxl_worker
, 0);
391 create_primary_surface(spice_screen
, width
, height
);
393 spice_screen_clear(spice_screen
, 0, 0, width
, height
);
397 QXLDevMemSlot slot
= {
398 .slot_group_id
= MEM_SLOT_GROUP_ID
,
408 attache_worker(QXLInstance
*qin
, QXLWorker
*_qxl_worker
)
410 SpiceScreen
*spice_screen
= SPICE_CONTAINEROF(qin
, SpiceScreen
, qxl_instance
);
412 if (spice_screen
->qxl_worker
) {
413 g_assert_not_reached();
416 spice_screen
->qxl_worker
= _qxl_worker
;
417 spice_screen
->qxl_worker
->add_memslot(spice_screen
->qxl_worker
, &slot
);
418 create_primary_surface(spice_screen
, spice_screen
->width
, spice_screen
->height
);
419 spice_screen
->qxl_worker
->start(spice_screen
->qxl_worker
);
423 set_compression_level(QXLInstance
*qin
, int level
)
429 set_mm_time(QXLInstance
*qin
, uint32_t mm_time
)
435 get_init_info(QXLInstance
*qin
, QXLDevInitInfo
*info
)
437 memset(info
, 0, sizeof(*info
));
438 info
->num_memslots
= 1;
439 info
->num_memslots_groups
= 1;
440 info
->memslot_id_bits
= 1;
441 info
->memslot_gen_bits
= 1;
442 info
->n_surfaces
= 1;
445 /* called from spice_server thread (i.e. red_worker thread) */
447 get_command(QXLInstance
*qin
, struct QXLCommandExt
*ext
)
449 SpiceScreen
*spice_screen
= SPICE_CONTAINEROF(qin
, SpiceScreen
, qxl_instance
);
452 g_mutex_lock(spice_screen
->command_mutex
);
454 if ((spice_screen
->commands_end
- spice_screen
->commands_start
) == 0) {
459 *ext
= *spice_screen
->commands
[spice_screen
->commands_start
% COMMANDS_SIZE
];
460 g_assert(spice_screen
->commands_start
< spice_screen
->commands_end
);
461 spice_screen
->commands_start
++;
462 g_cond_signal(spice_screen
->command_cond
);
467 g_mutex_unlock(spice_screen
->command_mutex
);
472 req_cmd_notification(QXLInstance
*qin
)
474 //SpiceScreen *spice_screen = SPICE_CONTAINEROF(qin, SpiceScreen, qxl_instance);
475 //spice_screen->core->timer_start(spice_screen->wakeup_timer, spice_screen->wakeup_ms);
481 release_resource(QXLInstance
*qin
, struct QXLReleaseInfoExt release_info
)
483 QXLCommandExt
*ext
= (QXLCommandExt
*)(unsigned long)release_info
.info
->id
;
485 g_assert(release_info
.group_id
== MEM_SLOT_GROUP_ID
);
486 switch (ext
->cmd
.type
) {
488 spice_screen_destroy_update((void*)ext
);
490 case QXL_CMD_SURFACE
:
493 case QXL_CMD_CURSOR
: {
494 QXLCursorCmd
*cmd
= (QXLCursorCmd
*)(unsigned long)ext
->cmd
.data
;
495 if (cmd
->type
== QXL_CURSOR_SET
) {
506 #define CURSOR_WIDTH 8
507 #define CURSOR_HEIGHT 16
511 uint8_t data
[CURSOR_WIDTH
* CURSOR_HEIGHT
* 4]; // 32bit per pixel
517 cursor
.cursor
.header
.unique
= 0;
518 cursor
.cursor
.header
.type
= SPICE_CURSOR_TYPE_COLOR32
;
519 cursor
.cursor
.header
.width
= CURSOR_WIDTH
;
520 cursor
.cursor
.header
.height
= CURSOR_HEIGHT
;
521 cursor
.cursor
.header
.hot_spot_x
= 0;
522 cursor
.cursor
.header
.hot_spot_y
= 0;
523 cursor
.cursor
.data_size
= CURSOR_WIDTH
* CURSOR_HEIGHT
* 4;
525 // X drivers addes it to the cursor size because it could be
526 // cursor data information or another cursor related stuffs.
527 // Otherwise, the code will break in client/cursor.cpp side,
528 // that expect the data_size plus cursor information.
529 // Blame cursor protocol for this. :-)
530 cursor
.cursor
.data_size
+= 128;
531 cursor
.cursor
.chunk
.data_size
= cursor
.cursor
.data_size
;
532 cursor
.cursor
.chunk
.prev_chunk
= cursor
.cursor
.chunk
.next_chunk
= 0;
536 get_cursor_command(QXLInstance
*qin
, struct QXLCommandExt
*ext
)
538 SpiceScreen
*spice_screen
= SPICE_CONTAINEROF(qin
, SpiceScreen
, qxl_instance
);
540 static int x
= 0, y
= 0;
541 QXLCursorCmd
*cursor_cmd
;
544 if (!spice_screen
->cursor_notify
) {
548 spice_screen
->cursor_notify
--;
549 cmd
= calloc(sizeof(QXLCommandExt
), 1);
550 cursor_cmd
= calloc(sizeof(QXLCursorCmd
), 1);
552 cursor_cmd
->release_info
.id
= (unsigned long)cmd
;
555 cursor_cmd
->type
= QXL_CURSOR_SET
;
556 cursor_cmd
->u
.set
.position
.x
= 0;
557 cursor_cmd
->u
.set
.position
.y
= 0;
558 cursor_cmd
->u
.set
.visible
= TRUE
;
559 cursor_cmd
->u
.set
.shape
= (unsigned long)&cursor
;
560 // white rect as cursor
561 memset(cursor
.data
, 255, sizeof(cursor
.data
));
564 cursor_cmd
->type
= QXL_CURSOR_MOVE
;
565 cursor_cmd
->u
.position
.x
= x
++ % spice_screen
->primary_width
;
566 cursor_cmd
->u
.position
.y
= y
++ % spice_screen
->primary_height
;
569 cmd
->cmd
.data
= (unsigned long)cursor_cmd
;
570 cmd
->cmd
.type
= QXL_CMD_CURSOR
;
571 cmd
->group_id
= MEM_SLOT_GROUP_ID
;
579 req_cursor_notification(QXLInstance
*qin
)
587 notify_update(QXLInstance
*qin
, uint32_t update_id
)
593 flush_resources(QXLInstance
*qin
)
601 client_monitors_config(QXLInstance
*qin
, VDAgentMonitorsConfig
*monitors_config
)
609 set_client_capabilities(QXLInstance
*qin
, uint8_t client_present
,
612 SpiceScreen
*spice_screen
= SPICE_CONTAINEROF(qin
, SpiceScreen
, qxl_instance
);
614 DPRINTF(1, "present %d caps %d", client_present
, caps
[0]);
616 if (spice_screen
->on_client_connected
&& client_present
) {
617 spice_screen
->on_client_connected(spice_screen
);
619 if (spice_screen
->on_client_disconnected
&& !client_present
) {
620 spice_screen
->on_client_disconnected(spice_screen
);
624 static int client_count
= 0;
627 client_connected(SpiceScreen
*spice_screen
)
631 DPRINTF(1, "client_count = %d", client_count
);
635 client_disconnected(SpiceScreen
*spice_screen
)
637 if (client_count
> 0) {
639 DPRINTF(1, "client_count = %d", client_count
);
640 exit(0); // fixme: cleanup?
645 do_conn_timeout(void *opaque
)
647 // SpiceScreen *spice_screen = opaque;
649 if (client_count
<= 0) {
650 printf("connection timeout - stopping server\n");
651 exit (0); // fixme: cleanup?
655 QXLInterface display_sif
= {
657 .type
= SPICE_INTERFACE_QXL
,
658 .description
= "spiceterm display server",
659 .major_version
= SPICE_INTERFACE_QXL_MAJOR
,
660 .minor_version
= SPICE_INTERFACE_QXL_MINOR
662 .attache_worker
= attache_worker
,
663 .set_compression_level
= set_compression_level
,
664 .set_mm_time
= set_mm_time
,
665 .get_init_info
= get_init_info
,
667 /* the callbacks below are called from spice server thread context */
668 .get_command
= get_command
,
669 .req_cmd_notification
= req_cmd_notification
,
670 .release_resource
= release_resource
,
671 .get_cursor_command
= get_cursor_command
,
672 .req_cursor_notification
= req_cursor_notification
,
673 .notify_update
= notify_update
,
674 .flush_resources
= flush_resources
,
675 .client_monitors_config
= client_monitors_config
,
676 .set_client_capabilities
= set_client_capabilities
,
681 spice_screen_draw_char(SpiceScreen
*spice_screen
, int x
, int y
, gunichar2 ch
,
682 TextAttributes attrib
)
688 invers
= attrib
.selected
? 0 : 1;
690 invers
= attrib
.selected
? 1 : 0;
705 // unsuported attributes = (attrib.blink || attrib.unvisible)
707 int c
= vt_fontmap
[ch
];
709 SimpleSpiceUpdate
*update
;
710 update
= spice_screen_draw_char_cmd(spice_screen
, x
, y
, c
, fg
, bg
, attrib
.uline
);
711 push_command(spice_screen
, &update
->ext
);
715 spice_screen_new(SpiceCoreInterface
*core
, uint32_t width
, uint32_t height
, guint timeout
)
718 SpiceScreen
*spice_screen
= g_new0(SpiceScreen
, 1);
719 SpiceServer
* server
= spice_server_new();
721 spice_screen
->width
= width
;
722 spice_screen
->height
= height
;
724 spice_screen
->command_cond
= g_cond_new();
725 spice_screen
->command_mutex
= g_mutex_new();
727 spice_screen
->on_client_connected
= client_connected
,
728 spice_screen
->on_client_disconnected
= client_disconnected
,
730 spice_screen
->qxl_instance
.base
.sif
= &display_sif
.base
;
731 spice_screen
->qxl_instance
.id
= 0;
733 spice_screen
->core
= core
;
734 spice_screen
->server
= server
;
736 spice_screen
->cursor_notify
= NOTIFY_CURSOR_BATCH
;
738 printf("listening on port %d (unsecure)\n", port
);
740 spice_server_set_port(server
, port
);
741 spice_server_set_noauth(server
);
743 int res
= spice_server_init(server
, core
);
745 g_error("spice_server_init failed, res = %d\n", res
);
750 spice_screen
->conn_timeout_timer
= core
->timer_add(do_conn_timeout
, spice_screen
);
751 spice_screen
->core
->timer_start(spice_screen
->conn_timeout_timer
, timeout
*1000);
753 spice_server_add_interface(spice_screen
->server
, &spice_screen
->qxl_instance
.base
);