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 #define DEFAULT_WIDTH 640
94 #define DEFAULT_HEIGHT 320
96 static int unique
= 0x0ffff + 1;
99 set_cmd(QXLCommandExt
*ext
, uint32_t type
, QXLPHYSICAL data
)
101 ext
->cmd
.type
= type
;
102 ext
->cmd
.data
= data
;
103 ext
->cmd
.padding
= 0;
104 ext
->group_id
= MEM_SLOT_GROUP_ID
;
109 simple_set_release_info(QXLReleaseInfo
*info
, intptr_t ptr
)
112 //info->group_id = MEM_SLOT_GROUP_ID;
115 /* Note: push_command/get_command are called from different threads */
118 push_command(SpiceScreen
*spice_screen
, QXLCommandExt
*ext
)
120 g_mutex_lock(spice_screen
->command_mutex
);
122 while (spice_screen
->commands_end
- spice_screen
->commands_start
>= COMMANDS_SIZE
) {
123 g_cond_wait(spice_screen
->command_cond
, spice_screen
->command_mutex
);
126 g_assert(spice_screen
->commands_end
- spice_screen
->commands_start
< COMMANDS_SIZE
);
128 spice_screen
->commands
[spice_screen
->commands_end
% COMMANDS_SIZE
] = ext
;
129 spice_screen
->commands_end
++;
131 g_mutex_unlock(spice_screen
->command_mutex
);
133 spice_screen
->qxl_worker
->wakeup(spice_screen
->qxl_worker
);
136 /* bitmap are freed, so they must be allocated with g_malloc */
137 static SimpleSpiceUpdate
*
138 spice_screen_update_from_bitmap_cmd(uint32_t surface_id
, QXLRect bbox
, uint8_t *bitmap
, int cache_id
)
140 SimpleSpiceUpdate
*update
;
141 QXLDrawable
*drawable
;
145 bh
= bbox
.bottom
- bbox
.top
;
146 bw
= bbox
.right
- bbox
.left
;
148 update
= g_new0(SimpleSpiceUpdate
, 1);
149 update
->bitmap
= bitmap
;
150 drawable
= &update
->drawable
;
151 image
= &update
->image
;
153 drawable
->surface_id
= surface_id
;
155 drawable
->bbox
= bbox
;
156 drawable
->clip
.type
= SPICE_CLIP_TYPE_NONE
;
157 drawable
->effect
= QXL_EFFECT_OPAQUE
;
158 simple_set_release_info(&drawable
->release_info
, (intptr_t)update
);
159 drawable
->type
= QXL_DRAW_COPY
;
160 drawable
->surfaces_dest
[0] = -1;
161 drawable
->surfaces_dest
[1] = -1;
162 drawable
->surfaces_dest
[2] = -1;
164 drawable
->u
.copy
.rop_descriptor
= SPICE_ROPD_OP_PUT
;
165 drawable
->u
.copy
.src_bitmap
= (intptr_t)image
;
166 drawable
->u
.copy
.src_area
.right
= bw
;
167 drawable
->u
.copy
.src_area
.bottom
= bh
;
170 QXL_SET_IMAGE_ID(image
, QXL_IMAGE_GROUP_DEVICE
, cache_id
);
172 QXL_SET_IMAGE_ID(image
, QXL_IMAGE_GROUP_DEVICE
, ++unique
);
174 image
->descriptor
.type
= SPICE_IMAGE_TYPE_BITMAP
;
175 image
->bitmap
.flags
= QXL_BITMAP_DIRECT
| QXL_BITMAP_TOP_DOWN
;
176 image
->bitmap
.stride
= bw
* 4;
177 image
->descriptor
.width
= image
->bitmap
.x
= bw
;
178 image
->descriptor
.height
= image
->bitmap
.y
= bh
;
179 image
->bitmap
.data
= (intptr_t)bitmap
;
180 image
->bitmap
.palette
= 0;
181 image
->bitmap
.format
= SPICE_BITMAP_FMT_32BIT
;
183 set_cmd(&update
->ext
, QXL_CMD_DRAW
, (intptr_t)drawable
);
188 static SimpleSpiceUpdate
*
189 spice_screen_draw_char_cmd(SpiceScreen
*spice_screen
, int x
, int y
, int c
,
190 int fg
, int bg
, gboolean uline
)
200 if (!uline
&& c
< 256) {
201 cache_id
= ((fg
<< 12) | (bg
<< 8) | (c
& 255)) & 0x0ffff;
210 bitmap
= dst
= g_malloc(bw
* bh
* 4);
212 unsigned char *data
= vt_font_data
+ c
*16;
213 unsigned char d
= *data
;
215 g_assert(fg
>= 0 && fg
< 16);
216 g_assert(bg
>= 0 && bg
< 16);
218 unsigned char fgc_red
= default_red
[fg
];
219 unsigned char fgc_blue
= default_blu
[fg
];
220 unsigned char fgc_green
= default_grn
[fg
];
221 unsigned char bgc_red
= default_red
[bg
];
222 unsigned char bgc_blue
= default_blu
[bg
];
223 unsigned char bgc_green
= default_grn
[bg
];
225 for (j
= 0; j
< 16; j
++) {
226 gboolean ul
= (j
== 14) && uline
;
227 for (i
= 0; i
< 8; i
++) {
234 *(dst
+1) = fgc_green
;
239 *(dst
+1) = bgc_green
;
248 bbox
.left
= left
; bbox
.top
= top
;
249 bbox
.right
= left
+ bw
; bbox
.bottom
= top
+ bh
;
251 return spice_screen_update_from_bitmap_cmd(0, bbox
, bitmap
, cache_id
);
255 spice_screen_scroll(SpiceScreen
*spice_screen
, int x1
, int y1
,
256 int x2
, int y2
, int src_x
, int src_y
)
258 SimpleSpiceUpdate
*update
;
259 QXLDrawable
*drawable
;
264 update
= g_new0(SimpleSpiceUpdate
, 1);
265 drawable
= &update
->drawable
;
272 drawable
->surface_id
= surface_id
;
274 drawable
->bbox
= bbox
;
275 drawable
->clip
.type
= SPICE_CLIP_TYPE_NONE
;
276 drawable
->effect
= QXL_EFFECT_OPAQUE
;
277 simple_set_release_info(&drawable
->release_info
, (intptr_t)update
);
278 drawable
->type
= QXL_COPY_BITS
;
279 drawable
->surfaces_dest
[0] = -1;
280 drawable
->surfaces_dest
[1] = -1;
281 drawable
->surfaces_dest
[2] = -1;
283 drawable
->u
.copy_bits
.src_pos
.x
= src_x
;
284 drawable
->u
.copy_bits
.src_pos
.y
= src_y
;
286 set_cmd(&update
->ext
, QXL_CMD_DRAW
, (intptr_t)drawable
);
288 push_command(spice_screen
, &update
->ext
);
292 spice_screen_clear(SpiceScreen
*spice_screen
, int x1
, int y1
, int x2
, int y2
)
294 SimpleSpiceUpdate
*update
;
295 QXLDrawable
*drawable
;
300 update
= g_new0(SimpleSpiceUpdate
, 1);
301 drawable
= &update
->drawable
;
308 drawable
->surface_id
= surface_id
;
310 drawable
->bbox
= bbox
;
311 drawable
->clip
.type
= SPICE_CLIP_TYPE_NONE
;
312 drawable
->effect
= QXL_EFFECT_OPAQUE
;
313 simple_set_release_info(&drawable
->release_info
, (intptr_t)update
);
314 drawable
->type
= QXL_DRAW_BLACKNESS
;
315 drawable
->surfaces_dest
[0] = -1;
316 drawable
->surfaces_dest
[1] = -1;
317 drawable
->surfaces_dest
[2] = -1;
319 set_cmd(&update
->ext
, QXL_CMD_DRAW
, (intptr_t)drawable
);
321 push_command(spice_screen
, &update
->ext
);
325 create_primary_surface(SpiceScreen
*spice_screen
, uint32_t width
,
328 QXLWorker
*qxl_worker
= spice_screen
->qxl_worker
;
329 QXLDevSurfaceCreate surface
= { 0, };
331 g_assert(height
<= MAX_HEIGHT
);
332 g_assert(width
<= MAX_WIDTH
);
333 g_assert(height
> 0);
336 surface
.format
= SPICE_SURFACE_FMT_32_xRGB
;
337 surface
.width
= spice_screen
->primary_width
= width
;
338 surface
.height
= spice_screen
->primary_height
= height
;
339 surface
.stride
= -width
* 4; /* negative? */
340 surface
.mouse_mode
= TRUE
; /* unused by red_worker */
342 surface
.type
= 0; /* unused by red_worker */
343 surface
.position
= 0; /* unused by red_worker */
344 surface
.mem
= (uint64_t)&spice_screen
->primary_surface
;
345 surface
.group_id
= MEM_SLOT_GROUP_ID
;
347 spice_screen
->width
= width
;
348 spice_screen
->height
= height
;
350 qxl_worker
->create_primary_surface(qxl_worker
, 0, &surface
);
353 QXLDevMemSlot slot
= {
354 .slot_group_id
= MEM_SLOT_GROUP_ID
,
364 attache_worker(QXLInstance
*qin
, QXLWorker
*_qxl_worker
)
366 SpiceScreen
*spice_screen
= SPICE_CONTAINEROF(qin
, SpiceScreen
, qxl_instance
);
368 if (spice_screen
->qxl_worker
) {
369 g_assert_not_reached();
372 spice_screen
->qxl_worker
= _qxl_worker
;
373 spice_screen
->qxl_worker
->add_memslot(spice_screen
->qxl_worker
, &slot
);
374 create_primary_surface(spice_screen
, DEFAULT_WIDTH
, DEFAULT_HEIGHT
);
375 spice_screen
->qxl_worker
->start(spice_screen
->qxl_worker
);
379 set_compression_level(QXLInstance
*qin
, int level
)
385 set_mm_time(QXLInstance
*qin
, uint32_t mm_time
)
391 get_init_info(QXLInstance
*qin
, QXLDevInitInfo
*info
)
393 memset(info
, 0, sizeof(*info
));
394 info
->num_memslots
= 1;
395 info
->num_memslots_groups
= 1;
396 info
->memslot_id_bits
= 1;
397 info
->memslot_gen_bits
= 1;
398 info
->n_surfaces
= 1;
401 /* called from spice_server thread (i.e. red_worker thread) */
403 get_command(QXLInstance
*qin
, struct QXLCommandExt
*ext
)
405 SpiceScreen
*spice_screen
= SPICE_CONTAINEROF(qin
, SpiceScreen
, qxl_instance
);
408 g_mutex_lock(spice_screen
->command_mutex
);
410 if ((spice_screen
->commands_end
- spice_screen
->commands_start
) == 0) {
415 *ext
= *spice_screen
->commands
[spice_screen
->commands_start
% COMMANDS_SIZE
];
416 g_assert(spice_screen
->commands_start
< spice_screen
->commands_end
);
417 spice_screen
->commands_start
++;
418 g_cond_signal(spice_screen
->command_cond
);
423 g_mutex_unlock(spice_screen
->command_mutex
);
428 req_cmd_notification(QXLInstance
*qin
)
430 //SpiceScreen *spice_screen = SPICE_CONTAINEROF(qin, SpiceScreen, qxl_instance);
431 //spice_screen->core->timer_start(spice_screen->wakeup_timer, spice_screen->wakeup_ms);
437 release_resource(QXLInstance
*qin
, struct QXLReleaseInfoExt release_info
)
439 QXLCommandExt
*ext
= (QXLCommandExt
*)(unsigned long)release_info
.info
->id
;
441 g_assert(release_info
.group_id
== MEM_SLOT_GROUP_ID
);
442 switch (ext
->cmd
.type
) {
444 spice_screen_destroy_update((void*)ext
);
446 case QXL_CMD_SURFACE
:
449 case QXL_CMD_CURSOR
: {
450 QXLCursorCmd
*cmd
= (QXLCursorCmd
*)(unsigned long)ext
->cmd
.data
;
451 if (cmd
->type
== QXL_CURSOR_SET
) {
462 #define CURSOR_WIDTH 8
463 #define CURSOR_HEIGHT 16
467 uint8_t data
[CURSOR_WIDTH
* CURSOR_HEIGHT
* 4]; // 32bit per pixel
473 cursor
.cursor
.header
.unique
= 0;
474 cursor
.cursor
.header
.type
= SPICE_CURSOR_TYPE_COLOR32
;
475 cursor
.cursor
.header
.width
= CURSOR_WIDTH
;
476 cursor
.cursor
.header
.height
= CURSOR_HEIGHT
;
477 cursor
.cursor
.header
.hot_spot_x
= 0;
478 cursor
.cursor
.header
.hot_spot_y
= 0;
479 cursor
.cursor
.data_size
= CURSOR_WIDTH
* CURSOR_HEIGHT
* 4;
481 // X drivers addes it to the cursor size because it could be
482 // cursor data information or another cursor related stuffs.
483 // Otherwise, the code will break in client/cursor.cpp side,
484 // that expect the data_size plus cursor information.
485 // Blame cursor protocol for this. :-)
486 cursor
.cursor
.data_size
+= 128;
487 cursor
.cursor
.chunk
.data_size
= cursor
.cursor
.data_size
;
488 cursor
.cursor
.chunk
.prev_chunk
= cursor
.cursor
.chunk
.next_chunk
= 0;
492 get_cursor_command(QXLInstance
*qin
, struct QXLCommandExt
*ext
)
494 SpiceScreen
*spice_screen
= SPICE_CONTAINEROF(qin
, SpiceScreen
, qxl_instance
);
496 static int x
= 0, y
= 0;
497 QXLCursorCmd
*cursor_cmd
;
500 if (!spice_screen
->cursor_notify
) {
504 spice_screen
->cursor_notify
--;
505 cmd
= calloc(sizeof(QXLCommandExt
), 1);
506 cursor_cmd
= calloc(sizeof(QXLCursorCmd
), 1);
508 cursor_cmd
->release_info
.id
= (unsigned long)cmd
;
511 cursor_cmd
->type
= QXL_CURSOR_SET
;
512 cursor_cmd
->u
.set
.position
.x
= 0;
513 cursor_cmd
->u
.set
.position
.y
= 0;
514 cursor_cmd
->u
.set
.visible
= TRUE
;
515 cursor_cmd
->u
.set
.shape
= (unsigned long)&cursor
;
516 // white rect as cursor
517 memset(cursor
.data
, 255, sizeof(cursor
.data
));
520 cursor_cmd
->type
= QXL_CURSOR_MOVE
;
521 cursor_cmd
->u
.position
.x
= x
++ % spice_screen
->primary_width
;
522 cursor_cmd
->u
.position
.y
= y
++ % spice_screen
->primary_height
;
525 cmd
->cmd
.data
= (unsigned long)cursor_cmd
;
526 cmd
->cmd
.type
= QXL_CMD_CURSOR
;
527 cmd
->group_id
= MEM_SLOT_GROUP_ID
;
535 req_cursor_notification(QXLInstance
*qin
)
543 notify_update(QXLInstance
*qin
, uint32_t update_id
)
549 flush_resources(QXLInstance
*qin
)
557 client_monitors_config(QXLInstance
*qin
, VDAgentMonitorsConfig
*monitors_config
)
565 set_client_capabilities(QXLInstance
*qin
, uint8_t client_present
,
568 SpiceScreen
*spice_screen
= SPICE_CONTAINEROF(qin
, SpiceScreen
, qxl_instance
);
570 DPRINTF(1, "present %d caps %d", client_present
, caps
[0]);
572 if (spice_screen
->on_client_connected
&& client_present
) {
573 spice_screen
->on_client_connected(spice_screen
);
575 if (spice_screen
->on_client_disconnected
&& !client_present
) {
576 spice_screen
->on_client_disconnected(spice_screen
);
580 static int client_count
= 0;
583 client_connected(SpiceScreen
*spice_screen
)
587 DPRINTF(1, "client_count = %d", client_count
);
591 client_disconnected(SpiceScreen
*spice_screen
)
593 if (client_count
> 0) {
595 DPRINTF(1, "client_count = %d", client_count
);
596 exit(0); // fixme: cleanup?
601 do_conn_timeout(void *opaque
)
603 // SpiceScreen *spice_screen = opaque;
605 if (client_count
<= 0) {
606 printf("connection timeout - stopping server\n");
607 exit (0); // fixme: cleanup?
611 QXLInterface display_sif
= {
613 .type
= SPICE_INTERFACE_QXL
,
614 .description
= "spiceterm display server",
615 .major_version
= SPICE_INTERFACE_QXL_MAJOR
,
616 .minor_version
= SPICE_INTERFACE_QXL_MINOR
618 .attache_worker
= attache_worker
,
619 .set_compression_level
= set_compression_level
,
620 .set_mm_time
= set_mm_time
,
621 .get_init_info
= get_init_info
,
623 /* the callbacks below are called from spice server thread context */
624 .get_command
= get_command
,
625 .req_cmd_notification
= req_cmd_notification
,
626 .release_resource
= release_resource
,
627 .get_cursor_command
= get_cursor_command
,
628 .req_cursor_notification
= req_cursor_notification
,
629 .notify_update
= notify_update
,
630 .flush_resources
= flush_resources
,
631 .client_monitors_config
= client_monitors_config
,
632 .set_client_capabilities
= set_client_capabilities
,
637 spice_screen_draw_char(SpiceScreen
*spice_screen
, int x
, int y
, gunichar2 ch
,
638 TextAttributes attrib
)
644 invers
= attrib
.selected
? 0 : 1;
646 invers
= attrib
.selected
? 1 : 0;
661 // unsuported attributes = (attrib.blink || attrib.unvisible)
663 int c
= vt_fontmap
[ch
];
665 SimpleSpiceUpdate
*update
;
666 update
= spice_screen_draw_char_cmd(spice_screen
, x
, y
, c
, fg
, bg
, attrib
.uline
);
667 push_command(spice_screen
, &update
->ext
);
671 spice_screen_new(SpiceCoreInterface
*core
, guint timeout
)
674 SpiceScreen
*spice_screen
= g_new0(SpiceScreen
, 1);
675 SpiceServer
* server
= spice_server_new();
677 spice_screen
->command_cond
= g_cond_new();
678 spice_screen
->command_mutex
= g_mutex_new();
680 spice_screen
->on_client_connected
= client_connected
,
681 spice_screen
->on_client_disconnected
= client_disconnected
,
683 spice_screen
->qxl_instance
.base
.sif
= &display_sif
.base
;
684 spice_screen
->qxl_instance
.id
= 0;
686 spice_screen
->core
= core
;
687 spice_screen
->server
= server
;
689 spice_screen
->cursor_notify
= NOTIFY_CURSOR_BATCH
;
691 printf("listening on port %d (unsecure)\n", port
);
693 spice_server_set_port(server
, port
);
694 spice_server_set_noauth(server
);
696 int res
= spice_server_init(server
, core
);
698 g_error("spice_server_init failed, res = %d\n", res
);
703 spice_screen
->conn_timeout_timer
= core
->timer_add(do_conn_timeout
, spice_screen
);
704 spice_screen
->core
->timer_start(spice_screen
->conn_timeout_timer
, timeout
*1000);
706 spice_server_add_interface(spice_screen
->server
, &spice_screen
->qxl_instance
.base
);