VirtualBox

source: vbox/trunk/src/VBox/Main/src-client/ConsoleVRDPServer.cpp@ 56268

Last change on this file since 56268 was 56085, checked in by vboxsync, 10 years ago

PDM/Audio: Removed old audio architecture.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 136.5 KB
Line 
1/* $Id: ConsoleVRDPServer.cpp 56085 2015-05-26 16:39:58Z vboxsync $ */
2/** @file
3 * VBox Console VRDP helper class.
4 */
5
6/*
7 * Copyright (C) 2006-2015 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18#include "ConsoleVRDPServer.h"
19#include "ConsoleImpl.h"
20#include "DisplayImpl.h"
21#include "KeyboardImpl.h"
22#include "MouseImpl.h"
23#include "DrvAudioVRDE.h"
24#ifdef VBOX_WITH_EXTPACK
25# include "ExtPackManagerImpl.h"
26#endif
27#include "VMMDev.h"
28#ifdef VBOX_WITH_USB_CARDREADER
29# include "UsbCardReader.h"
30#endif
31#include "UsbWebcamInterface.h"
32
33#include "Global.h"
34#include "AutoCaller.h"
35#include "Logging.h"
36
37#include <iprt/asm.h>
38#include <iprt/alloca.h>
39#include <iprt/ldr.h>
40#include <iprt/param.h>
41#include <iprt/path.h>
42#include <iprt/cpp/utils.h>
43
44#include <VBox/err.h>
45#include <VBox/RemoteDesktop/VRDEOrders.h>
46#include <VBox/com/listeners.h>
47#include <VBox/HostServices/VBoxCrOpenGLSvc.h>
48
49class VRDPConsoleListener
50{
51public:
52 VRDPConsoleListener()
53 {
54 }
55
56 HRESULT init(ConsoleVRDPServer *server)
57 {
58 m_server = server;
59 return S_OK;
60 }
61
62 void uninit()
63 {
64 }
65
66 STDMETHOD(HandleEvent)(VBoxEventType_T aType, IEvent * aEvent)
67 {
68 switch (aType)
69 {
70 case VBoxEventType_OnMousePointerShapeChanged:
71 {
72 ComPtr<IMousePointerShapeChangedEvent> mpscev = aEvent;
73 Assert(mpscev);
74 BOOL visible, alpha;
75 ULONG xHot, yHot, width, height;
76 com::SafeArray <BYTE> shape;
77
78 mpscev->COMGETTER(Visible)(&visible);
79 mpscev->COMGETTER(Alpha)(&alpha);
80 mpscev->COMGETTER(Xhot)(&xHot);
81 mpscev->COMGETTER(Yhot)(&yHot);
82 mpscev->COMGETTER(Width)(&width);
83 mpscev->COMGETTER(Height)(&height);
84 mpscev->COMGETTER(Shape)(ComSafeArrayAsOutParam(shape));
85
86 m_server->onMousePointerShapeChange(visible, alpha, xHot, yHot, width, height, ComSafeArrayAsInParam(shape));
87 break;
88 }
89 case VBoxEventType_OnMouseCapabilityChanged:
90 {
91 ComPtr<IMouseCapabilityChangedEvent> mccev = aEvent;
92 Assert(mccev);
93 if (m_server)
94 {
95 BOOL fAbsoluteMouse;
96 mccev->COMGETTER(SupportsAbsolute)(&fAbsoluteMouse);
97 m_server->NotifyAbsoluteMouse(!!fAbsoluteMouse);
98 }
99 break;
100 }
101 case VBoxEventType_OnKeyboardLedsChanged:
102 {
103 ComPtr<IKeyboardLedsChangedEvent> klcev = aEvent;
104 Assert(klcev);
105
106 if (m_server)
107 {
108 BOOL fNumLock, fCapsLock, fScrollLock;
109 klcev->COMGETTER(NumLock)(&fNumLock);
110 klcev->COMGETTER(CapsLock)(&fCapsLock);
111 klcev->COMGETTER(ScrollLock)(&fScrollLock);
112 m_server->NotifyKeyboardLedsChange(fNumLock, fCapsLock, fScrollLock);
113 }
114 break;
115 }
116
117 default:
118 AssertFailed();
119 }
120
121 return S_OK;
122 }
123
124private:
125 ConsoleVRDPServer *m_server;
126};
127
128typedef ListenerImpl<VRDPConsoleListener, ConsoleVRDPServer*> VRDPConsoleListenerImpl;
129
130VBOX_LISTENER_DECLARE(VRDPConsoleListenerImpl)
131
132#ifdef DEBUG_sunlover
133#define LOGDUMPPTR Log
134void dumpPointer(const uint8_t *pu8Shape, uint32_t width, uint32_t height, bool fXorMaskRGB32)
135{
136 unsigned i;
137
138 const uint8_t *pu8And = pu8Shape;
139
140 for (i = 0; i < height; i++)
141 {
142 unsigned j;
143 LOGDUMPPTR(("%p: ", pu8And));
144 for (j = 0; j < (width + 7) / 8; j++)
145 {
146 unsigned k;
147 for (k = 0; k < 8; k++)
148 {
149 LOGDUMPPTR(("%d", ((*pu8And) & (1 << (7 - k)))? 1: 0));
150 }
151
152 pu8And++;
153 }
154 LOGDUMPPTR(("\n"));
155 }
156
157 if (fXorMaskRGB32)
158 {
159 uint32_t *pu32Xor = (uint32_t*)(pu8Shape + ((((width + 7) / 8) * height + 3) & ~3));
160
161 for (i = 0; i < height; i++)
162 {
163 unsigned j;
164 LOGDUMPPTR(("%p: ", pu32Xor));
165 for (j = 0; j < width; j++)
166 {
167 LOGDUMPPTR(("%08X", *pu32Xor++));
168 }
169 LOGDUMPPTR(("\n"));
170 }
171 }
172 else
173 {
174 /* RDP 24 bit RGB mask. */
175 uint8_t *pu8Xor = (uint8_t*)(pu8Shape + ((((width + 7) / 8) * height + 3) & ~3));
176 for (i = 0; i < height; i++)
177 {
178 unsigned j;
179 LOGDUMPPTR(("%p: ", pu8Xor));
180 for (j = 0; j < width; j++)
181 {
182 LOGDUMPPTR(("%02X%02X%02X", pu8Xor[2], pu8Xor[1], pu8Xor[0]));
183 pu8Xor += 3;
184 }
185 LOGDUMPPTR(("\n"));
186 }
187 }
188}
189#else
190#define dumpPointer(a, b, c, d) do {} while (0)
191#endif /* DEBUG_sunlover */
192
193static void findTopLeftBorder(const uint8_t *pu8AndMask, const uint8_t *pu8XorMask, uint32_t width,
194 uint32_t height, uint32_t *pxSkip, uint32_t *pySkip)
195{
196 /*
197 * Find the top border of the AND mask. First assign to special value.
198 */
199 uint32_t ySkipAnd = ~0;
200
201 const uint8_t *pu8And = pu8AndMask;
202 const uint32_t cbAndRow = (width + 7) / 8;
203 const uint8_t maskLastByte = (uint8_t)( 0xFF << (cbAndRow * 8 - width) );
204
205 Assert(cbAndRow > 0);
206
207 unsigned y;
208 unsigned x;
209
210 for (y = 0; y < height && ySkipAnd == ~(uint32_t)0; y++, pu8And += cbAndRow)
211 {
212 /* For each complete byte in the row. */
213 for (x = 0; x < cbAndRow - 1; x++)
214 {
215 if (pu8And[x] != 0xFF)
216 {
217 ySkipAnd = y;
218 break;
219 }
220 }
221
222 if (ySkipAnd == ~(uint32_t)0)
223 {
224 /* Last byte. */
225 if ((pu8And[cbAndRow - 1] & maskLastByte) != maskLastByte)
226 {
227 ySkipAnd = y;
228 }
229 }
230 }
231
232 if (ySkipAnd == ~(uint32_t)0)
233 {
234 ySkipAnd = 0;
235 }
236
237 /*
238 * Find the left border of the AND mask.
239 */
240 uint32_t xSkipAnd = ~0;
241
242 /* For all bit columns. */
243 for (x = 0; x < width && xSkipAnd == ~(uint32_t)0; x++)
244 {
245 pu8And = pu8AndMask + x/8; /* Currently checking byte. */
246 uint8_t mask = 1 << (7 - x%8); /* Currently checking bit in the byte. */
247
248 for (y = ySkipAnd; y < height; y++, pu8And += cbAndRow)
249 {
250 if ((*pu8And & mask) == 0)
251 {
252 xSkipAnd = x;
253 break;
254 }
255 }
256 }
257
258 if (xSkipAnd == ~(uint32_t)0)
259 {
260 xSkipAnd = 0;
261 }
262
263 /*
264 * Find the XOR mask top border.
265 */
266 uint32_t ySkipXor = ~0;
267
268 uint32_t *pu32XorStart = (uint32_t *)pu8XorMask;
269
270 uint32_t *pu32Xor = pu32XorStart;
271
272 for (y = 0; y < height && ySkipXor == ~(uint32_t)0; y++, pu32Xor += width)
273 {
274 for (x = 0; x < width; x++)
275 {
276 if (pu32Xor[x] != 0)
277 {
278 ySkipXor = y;
279 break;
280 }
281 }
282 }
283
284 if (ySkipXor == ~(uint32_t)0)
285 {
286 ySkipXor = 0;
287 }
288
289 /*
290 * Find the left border of the XOR mask.
291 */
292 uint32_t xSkipXor = ~(uint32_t)0;
293
294 /* For all columns. */
295 for (x = 0; x < width && xSkipXor == ~(uint32_t)0; x++)
296 {
297 pu32Xor = pu32XorStart + x; /* Currently checking dword. */
298
299 for (y = ySkipXor; y < height; y++, pu32Xor += width)
300 {
301 if (*pu32Xor != 0)
302 {
303 xSkipXor = x;
304 break;
305 }
306 }
307 }
308
309 if (xSkipXor == ~(uint32_t)0)
310 {
311 xSkipXor = 0;
312 }
313
314 *pxSkip = RT_MIN(xSkipAnd, xSkipXor);
315 *pySkip = RT_MIN(ySkipAnd, ySkipXor);
316}
317
318/* Generate an AND mask for alpha pointers here, because
319 * guest driver does not do that correctly for Vista pointers.
320 * Similar fix, changing the alpha threshold, could be applied
321 * for the guest driver, but then additions reinstall would be
322 * necessary, which we try to avoid.
323 */
324static void mousePointerGenerateANDMask(uint8_t *pu8DstAndMask, int cbDstAndMask, const uint8_t *pu8SrcAlpha, int w, int h)
325{
326 memset(pu8DstAndMask, 0xFF, cbDstAndMask);
327
328 int y;
329 for (y = 0; y < h; y++)
330 {
331 uint8_t bitmask = 0x80;
332
333 int x;
334 for (x = 0; x < w; x++, bitmask >>= 1)
335 {
336 if (bitmask == 0)
337 {
338 bitmask = 0x80;
339 }
340
341 /* Whether alpha channel value is not transparent enough for the pixel to be seen. */
342 if (pu8SrcAlpha[x * 4 + 3] > 0x7f)
343 {
344 pu8DstAndMask[x / 8] &= ~bitmask;
345 }
346 }
347
348 /* Point to next source and dest scans. */
349 pu8SrcAlpha += w * 4;
350 pu8DstAndMask += (w + 7) / 8;
351 }
352}
353
354void ConsoleVRDPServer::onMousePointerShapeChange(BOOL visible,
355 BOOL alpha,
356 ULONG xHot,
357 ULONG yHot,
358 ULONG width,
359 ULONG height,
360 ComSafeArrayIn(BYTE,inShape))
361{
362 Log9(("VRDPConsoleListener::OnMousePointerShapeChange: %d, %d, %lux%lu, @%lu,%lu\n",
363 visible, alpha, width, height, xHot, yHot));
364
365 com::SafeArray <BYTE> aShape(ComSafeArrayInArg(inShape));
366 if (aShape.size() == 0)
367 {
368 if (!visible)
369 {
370 MousePointerHide();
371 }
372 }
373 else if (width != 0 && height != 0)
374 {
375 uint8_t* shape = aShape.raw();
376
377 dumpPointer(shape, width, height, true);
378
379 /* Try the new interface. */
380 if (MousePointer(alpha, xHot, yHot, width, height, shape) == VINF_SUCCESS)
381 {
382 return;
383 }
384
385 /* Continue with the old interface. */
386
387 /* Pointer consists of 1 bpp AND and 24 BPP XOR masks.
388 * 'shape' AND mask followed by XOR mask.
389 * XOR mask contains 32 bit (lsb)BGR0(msb) values.
390 *
391 * We convert this to RDP color format which consist of
392 * one bpp AND mask and 24 BPP (BGR) color XOR image.
393 *
394 * RDP clients expect 8 aligned width and height of
395 * pointer (preferably 32x32).
396 *
397 * They even contain bugs which do not appear for
398 * 32x32 pointers but would appear for a 41x32 one.
399 *
400 * So set pointer size to 32x32. This can be done safely
401 * because most pointers are 32x32.
402 */
403
404 int cbDstAndMask = (((width + 7) / 8) * height + 3) & ~3;
405
406 uint8_t *pu8AndMask = shape;
407 uint8_t *pu8XorMask = shape + cbDstAndMask;
408
409 if (alpha)
410 {
411 pu8AndMask = (uint8_t*)alloca(cbDstAndMask);
412
413 mousePointerGenerateANDMask(pu8AndMask, cbDstAndMask, pu8XorMask, width, height);
414 }
415
416 /* Windows guest alpha pointers are wider than 32 pixels.
417 * Try to find out the top-left border of the pointer and
418 * then copy only meaningful bits. All complete top rows
419 * and all complete left columns where (AND == 1 && XOR == 0)
420 * are skipped. Hot spot is adjusted.
421 */
422 uint32_t ySkip = 0; /* How many rows to skip at the top. */
423 uint32_t xSkip = 0; /* How many columns to skip at the left. */
424
425 findTopLeftBorder(pu8AndMask, pu8XorMask, width, height, &xSkip, &ySkip);
426
427 /* Must not skip the hot spot. */
428 xSkip = RT_MIN(xSkip, xHot);
429 ySkip = RT_MIN(ySkip, yHot);
430
431 /*
432 * Compute size and allocate memory for the pointer.
433 */
434 const uint32_t dstwidth = 32;
435 const uint32_t dstheight = 32;
436
437 VRDECOLORPOINTER *pointer = NULL;
438
439 uint32_t dstmaskwidth = (dstwidth + 7) / 8;
440
441 uint32_t rdpmaskwidth = dstmaskwidth;
442 uint32_t rdpmasklen = dstheight * rdpmaskwidth;
443
444 uint32_t rdpdatawidth = dstwidth * 3;
445 uint32_t rdpdatalen = dstheight * rdpdatawidth;
446
447 pointer = (VRDECOLORPOINTER *)RTMemTmpAlloc(sizeof(VRDECOLORPOINTER) + rdpmasklen + rdpdatalen);
448
449 if (pointer)
450 {
451 uint8_t *maskarray = (uint8_t*)pointer + sizeof(VRDECOLORPOINTER);
452 uint8_t *dataarray = maskarray + rdpmasklen;
453
454 memset(maskarray, 0xFF, rdpmasklen);
455 memset(dataarray, 0x00, rdpdatalen);
456
457 uint32_t srcmaskwidth = (width + 7) / 8;
458 uint32_t srcdatawidth = width * 4;
459
460 /* Copy AND mask. */
461 uint8_t *src = pu8AndMask + ySkip * srcmaskwidth;
462 uint8_t *dst = maskarray + (dstheight - 1) * rdpmaskwidth;
463
464 uint32_t minheight = RT_MIN(height - ySkip, dstheight);
465 uint32_t minwidth = RT_MIN(width - xSkip, dstwidth);
466
467 unsigned x, y;
468
469 for (y = 0; y < minheight; y++)
470 {
471 for (x = 0; x < minwidth; x++)
472 {
473 uint32_t byteIndex = (x + xSkip) / 8;
474 uint32_t bitIndex = (x + xSkip) % 8;
475
476 bool bit = (src[byteIndex] & (1 << (7 - bitIndex))) != 0;
477
478 if (!bit)
479 {
480 byteIndex = x / 8;
481 bitIndex = x % 8;
482
483 dst[byteIndex] &= ~(1 << (7 - bitIndex));
484 }
485 }
486
487 src += srcmaskwidth;
488 dst -= rdpmaskwidth;
489 }
490
491 /* Point src to XOR mask */
492 src = pu8XorMask + ySkip * srcdatawidth;
493 dst = dataarray + (dstheight - 1) * rdpdatawidth;
494
495 for (y = 0; y < minheight ; y++)
496 {
497 for (x = 0; x < minwidth; x++)
498 {
499 memcpy(dst + x * 3, &src[4 * (x + xSkip)], 3);
500 }
501
502 src += srcdatawidth;
503 dst -= rdpdatawidth;
504 }
505
506 pointer->u16HotX = (uint16_t)(xHot - xSkip);
507 pointer->u16HotY = (uint16_t)(yHot - ySkip);
508
509 pointer->u16Width = (uint16_t)dstwidth;
510 pointer->u16Height = (uint16_t)dstheight;
511
512 pointer->u16MaskLen = (uint16_t)rdpmasklen;
513 pointer->u16DataLen = (uint16_t)rdpdatalen;
514
515 dumpPointer((uint8_t*)pointer + sizeof(*pointer), dstwidth, dstheight, false);
516
517 MousePointerUpdate(pointer);
518
519 RTMemTmpFree(pointer);
520 }
521 }
522}
523
524
525// ConsoleVRDPServer
526////////////////////////////////////////////////////////////////////////////////
527
528RTLDRMOD ConsoleVRDPServer::mVRDPLibrary = NIL_RTLDRMOD;
529
530PFNVRDECREATESERVER ConsoleVRDPServer::mpfnVRDECreateServer = NULL;
531
532VRDEENTRYPOINTS_4 ConsoleVRDPServer::mEntryPoints; /* A copy of the server entry points. */
533VRDEENTRYPOINTS_4 *ConsoleVRDPServer::mpEntryPoints = NULL;
534
535VRDECALLBACKS_4 ConsoleVRDPServer::mCallbacks =
536{
537 { VRDE_INTERFACE_VERSION_4, sizeof(VRDECALLBACKS_4) },
538 ConsoleVRDPServer::VRDPCallbackQueryProperty,
539 ConsoleVRDPServer::VRDPCallbackClientLogon,
540 ConsoleVRDPServer::VRDPCallbackClientConnect,
541 ConsoleVRDPServer::VRDPCallbackClientDisconnect,
542 ConsoleVRDPServer::VRDPCallbackIntercept,
543 ConsoleVRDPServer::VRDPCallbackUSB,
544 ConsoleVRDPServer::VRDPCallbackClipboard,
545 ConsoleVRDPServer::VRDPCallbackFramebufferQuery,
546 ConsoleVRDPServer::VRDPCallbackFramebufferLock,
547 ConsoleVRDPServer::VRDPCallbackFramebufferUnlock,
548 ConsoleVRDPServer::VRDPCallbackInput,
549 ConsoleVRDPServer::VRDPCallbackVideoModeHint,
550 ConsoleVRDPServer::VRDECallbackAudioIn
551};
552
553DECLCALLBACK(int) ConsoleVRDPServer::VRDPCallbackQueryProperty(void *pvCallback, uint32_t index, void *pvBuffer,
554 uint32_t cbBuffer, uint32_t *pcbOut)
555{
556 ConsoleVRDPServer *server = static_cast<ConsoleVRDPServer*>(pvCallback);
557
558 int rc = VERR_NOT_SUPPORTED;
559
560 switch (index)
561 {
562 case VRDE_QP_NETWORK_PORT:
563 {
564 /* This is obsolete, the VRDE server uses VRDE_QP_NETWORK_PORT_RANGE instead. */
565 ULONG port = 0;
566
567 if (cbBuffer >= sizeof(uint32_t))
568 {
569 *(uint32_t *)pvBuffer = (uint32_t)port;
570 rc = VINF_SUCCESS;
571 }
572 else
573 {
574 rc = VINF_BUFFER_OVERFLOW;
575 }
576
577 *pcbOut = sizeof(uint32_t);
578 } break;
579
580 case VRDE_QP_NETWORK_ADDRESS:
581 {
582 com::Bstr bstr;
583 server->mConsole->i_getVRDEServer()->GetVRDEProperty(Bstr("TCP/Address").raw(), bstr.asOutParam());
584
585 /* The server expects UTF8. */
586 com::Utf8Str address = bstr;
587
588 size_t cbAddress = address.length() + 1;
589
590 if (cbAddress >= 0x10000)
591 {
592 /* More than 64K seems to be an invalid address. */
593 rc = VERR_TOO_MUCH_DATA;
594 break;
595 }
596
597 if ((size_t)cbBuffer >= cbAddress)
598 {
599 memcpy(pvBuffer, address.c_str(), cbAddress);
600 rc = VINF_SUCCESS;
601 }
602 else
603 {
604 rc = VINF_BUFFER_OVERFLOW;
605 }
606
607 *pcbOut = (uint32_t)cbAddress;
608 } break;
609
610 case VRDE_QP_NUMBER_MONITORS:
611 {
612 ULONG cMonitors = 1;
613
614 server->mConsole->i_machine()->COMGETTER(MonitorCount)(&cMonitors);
615
616 if (cbBuffer >= sizeof(uint32_t))
617 {
618 *(uint32_t *)pvBuffer = (uint32_t)cMonitors;
619 rc = VINF_SUCCESS;
620 }
621 else
622 {
623 rc = VINF_BUFFER_OVERFLOW;
624 }
625
626 *pcbOut = sizeof(uint32_t);
627 } break;
628
629 case VRDE_QP_NETWORK_PORT_RANGE:
630 {
631 com::Bstr bstr;
632 HRESULT hrc = server->mConsole->i_getVRDEServer()->GetVRDEProperty(Bstr("TCP/Ports").raw(), bstr.asOutParam());
633
634 if (hrc != S_OK)
635 {
636 bstr = "";
637 }
638
639 if (bstr == "0")
640 {
641 bstr = "3389";
642 }
643
644 /* The server expects UTF8. */
645 com::Utf8Str portRange = bstr;
646
647 size_t cbPortRange = portRange.length() + 1;
648
649 if (cbPortRange >= _64K)
650 {
651 /* More than 64K seems to be an invalid port range string. */
652 rc = VERR_TOO_MUCH_DATA;
653 break;
654 }
655
656 if ((size_t)cbBuffer >= cbPortRange)
657 {
658 memcpy(pvBuffer, portRange.c_str(), cbPortRange);
659 rc = VINF_SUCCESS;
660 }
661 else
662 {
663 rc = VINF_BUFFER_OVERFLOW;
664 }
665
666 *pcbOut = (uint32_t)cbPortRange;
667 } break;
668
669 case VRDE_QP_VIDEO_CHANNEL:
670 {
671 com::Bstr bstr;
672 HRESULT hrc = server->mConsole->i_getVRDEServer()->GetVRDEProperty(Bstr("VideoChannel/Enabled").raw(),
673 bstr.asOutParam());
674
675 if (hrc != S_OK)
676 {
677 bstr = "";
678 }
679
680 com::Utf8Str value = bstr;
681
682 BOOL fVideoEnabled = RTStrICmp(value.c_str(), "true") == 0
683 || RTStrICmp(value.c_str(), "1") == 0;
684
685 if (cbBuffer >= sizeof(uint32_t))
686 {
687 *(uint32_t *)pvBuffer = (uint32_t)fVideoEnabled;
688 rc = VINF_SUCCESS;
689 }
690 else
691 {
692 rc = VINF_BUFFER_OVERFLOW;
693 }
694
695 *pcbOut = sizeof(uint32_t);
696 } break;
697
698 case VRDE_QP_VIDEO_CHANNEL_QUALITY:
699 {
700 com::Bstr bstr;
701 HRESULT hrc = server->mConsole->i_getVRDEServer()->GetVRDEProperty(Bstr("VideoChannel/Quality").raw(),
702 bstr.asOutParam());
703
704 if (hrc != S_OK)
705 {
706 bstr = "";
707 }
708
709 com::Utf8Str value = bstr;
710
711 ULONG ulQuality = RTStrToUInt32(value.c_str()); /* This returns 0 on invalid string which is ok. */
712
713 if (cbBuffer >= sizeof(uint32_t))
714 {
715 *(uint32_t *)pvBuffer = (uint32_t)ulQuality;
716 rc = VINF_SUCCESS;
717 }
718 else
719 {
720 rc = VINF_BUFFER_OVERFLOW;
721 }
722
723 *pcbOut = sizeof(uint32_t);
724 } break;
725
726 case VRDE_QP_VIDEO_CHANNEL_SUNFLSH:
727 {
728 ULONG ulSunFlsh = 1;
729
730 com::Bstr bstr;
731 HRESULT hrc = server->mConsole->i_machine()->GetExtraData(Bstr("VRDP/SunFlsh").raw(),
732 bstr.asOutParam());
733 if (hrc == S_OK && !bstr.isEmpty())
734 {
735 com::Utf8Str sunFlsh = bstr;
736 if (!sunFlsh.isEmpty())
737 {
738 ulSunFlsh = sunFlsh.toUInt32();
739 }
740 }
741
742 if (cbBuffer >= sizeof(uint32_t))
743 {
744 *(uint32_t *)pvBuffer = (uint32_t)ulSunFlsh;
745 rc = VINF_SUCCESS;
746 }
747 else
748 {
749 rc = VINF_BUFFER_OVERFLOW;
750 }
751
752 *pcbOut = sizeof(uint32_t);
753 } break;
754
755 case VRDE_QP_FEATURE:
756 {
757 if (cbBuffer < sizeof(VRDEFEATURE))
758 {
759 rc = VERR_INVALID_PARAMETER;
760 break;
761 }
762
763 size_t cbInfo = cbBuffer - RT_OFFSETOF(VRDEFEATURE, achInfo);
764
765 VRDEFEATURE *pFeature = (VRDEFEATURE *)pvBuffer;
766
767 size_t cchInfo = 0;
768 rc = RTStrNLenEx(pFeature->achInfo, cbInfo, &cchInfo);
769
770 if (RT_FAILURE(rc))
771 {
772 rc = VERR_INVALID_PARAMETER;
773 break;
774 }
775
776 Log(("VRDE_QP_FEATURE [%s]\n", pFeature->achInfo));
777
778 com::Bstr bstrValue;
779
780 if ( RTStrICmp(pFeature->achInfo, "Client/DisableDisplay") == 0
781 || RTStrICmp(pFeature->achInfo, "Client/DisableInput") == 0
782 || RTStrICmp(pFeature->achInfo, "Client/DisableAudio") == 0
783 || RTStrICmp(pFeature->achInfo, "Client/DisableUSB") == 0
784 || RTStrICmp(pFeature->achInfo, "Client/DisableClipboard") == 0
785 )
786 {
787 /* @todo these features should be per client. */
788 NOREF(pFeature->u32ClientId);
789
790 /* These features are mapped to "VRDE/Feature/NAME" extra data. */
791 com::Utf8Str extraData("VRDE/Feature/");
792 extraData += pFeature->achInfo;
793
794 HRESULT hrc = server->mConsole->i_machine()->GetExtraData(com::Bstr(extraData).raw(),
795 bstrValue.asOutParam());
796 if (FAILED(hrc) || bstrValue.isEmpty())
797 {
798 /* Also try the old "VRDP/Feature/NAME" */
799 extraData = "VRDP/Feature/";
800 extraData += pFeature->achInfo;
801
802 hrc = server->mConsole->i_machine()->GetExtraData(com::Bstr(extraData).raw(),
803 bstrValue.asOutParam());
804 if (FAILED(hrc))
805 {
806 rc = VERR_NOT_SUPPORTED;
807 }
808 }
809 }
810 else if (RTStrNCmp(pFeature->achInfo, "Property/", 9) == 0)
811 {
812 /* Generic properties. */
813 const char *pszPropertyName = &pFeature->achInfo[9];
814 HRESULT hrc = server->mConsole->i_getVRDEServer()->GetVRDEProperty(Bstr(pszPropertyName).raw(),
815 bstrValue.asOutParam());
816 if (FAILED(hrc))
817 {
818 rc = VERR_NOT_SUPPORTED;
819 }
820 }
821 else
822 {
823 rc = VERR_NOT_SUPPORTED;
824 }
825
826 /* Copy the value string to the callers buffer. */
827 if (rc == VINF_SUCCESS)
828 {
829 com::Utf8Str value = bstrValue;
830
831 size_t cb = value.length() + 1;
832
833 if ((size_t)cbInfo >= cb)
834 {
835 memcpy(pFeature->achInfo, value.c_str(), cb);
836 }
837 else
838 {
839 rc = VINF_BUFFER_OVERFLOW;
840 }
841
842 *pcbOut = (uint32_t)cb;
843 }
844 } break;
845
846 case VRDE_SP_NETWORK_BIND_PORT:
847 {
848 if (cbBuffer != sizeof(uint32_t))
849 {
850 rc = VERR_INVALID_PARAMETER;
851 break;
852 }
853
854 ULONG port = *(uint32_t *)pvBuffer;
855
856 server->mVRDPBindPort = port;
857
858 rc = VINF_SUCCESS;
859
860 if (pcbOut)
861 {
862 *pcbOut = sizeof(uint32_t);
863 }
864
865 server->mConsole->i_onVRDEServerInfoChange();
866 } break;
867
868 case VRDE_SP_CLIENT_STATUS:
869 {
870 if (cbBuffer < sizeof(VRDECLIENTSTATUS))
871 {
872 rc = VERR_INVALID_PARAMETER;
873 break;
874 }
875
876 size_t cbStatus = cbBuffer - RT_UOFFSETOF(VRDECLIENTSTATUS, achStatus);
877
878 VRDECLIENTSTATUS *pStatus = (VRDECLIENTSTATUS *)pvBuffer;
879
880 if (cbBuffer < RT_UOFFSETOF(VRDECLIENTSTATUS, achStatus) + pStatus->cbStatus)
881 {
882 rc = VERR_INVALID_PARAMETER;
883 break;
884 }
885
886 size_t cchStatus = 0;
887 rc = RTStrNLenEx(pStatus->achStatus, cbStatus, &cchStatus);
888
889 if (RT_FAILURE(rc))
890 {
891 rc = VERR_INVALID_PARAMETER;
892 break;
893 }
894
895 Log(("VRDE_SP_CLIENT_STATUS [%s]\n", pStatus->achStatus));
896
897 server->mConsole->i_VRDPClientStatusChange(pStatus->u32ClientId, pStatus->achStatus);
898
899 rc = VINF_SUCCESS;
900
901 if (pcbOut)
902 {
903 *pcbOut = cbBuffer;
904 }
905
906 server->mConsole->i_onVRDEServerInfoChange();
907 } break;
908
909 default:
910 break;
911 }
912
913 return rc;
914}
915
916DECLCALLBACK(int) ConsoleVRDPServer::VRDPCallbackClientLogon(void *pvCallback, uint32_t u32ClientId, const char *pszUser,
917 const char *pszPassword, const char *pszDomain)
918{
919 ConsoleVRDPServer *server = static_cast<ConsoleVRDPServer*>(pvCallback);
920
921 return server->mConsole->i_VRDPClientLogon(u32ClientId, pszUser, pszPassword, pszDomain);
922}
923
924DECLCALLBACK(void) ConsoleVRDPServer::VRDPCallbackClientConnect(void *pvCallback, uint32_t u32ClientId)
925{
926 ConsoleVRDPServer *server = static_cast<ConsoleVRDPServer*>(pvCallback);
927
928 server->mConsole->i_VRDPClientConnect(u32ClientId);
929
930 /* Should the server report usage of an interface for each client?
931 * Similar to Intercept.
932 */
933 int c = ASMAtomicIncS32(&server->mcClients);
934 if (c == 1)
935 {
936 /* Features which should be enabled only if there is a client. */
937 server->remote3DRedirect(true);
938 }
939}
940
941DECLCALLBACK(void) ConsoleVRDPServer::VRDPCallbackClientDisconnect(void *pvCallback, uint32_t u32ClientId,
942 uint32_t fu32Intercepted)
943{
944 ConsoleVRDPServer *pServer = static_cast<ConsoleVRDPServer*>(pvCallback);
945 AssertPtrReturnVoid(pServer);
946
947 pServer->mConsole->i_VRDPClientDisconnect(u32ClientId, fu32Intercepted);
948
949 if (ASMAtomicReadU32(&pServer->mu32AudioInputClientId) == u32ClientId)
950 {
951 LogFunc(("Disconnected client %u\n", u32ClientId));
952 ASMAtomicWriteU32(&pServer->mu32AudioInputClientId, 0);
953
954 AudioVRDE *pVRDE = pServer->mConsole->i_getAudioVRDE();
955 if (pVRDE)
956 pVRDE->onVRDEInputIntercept(false /* fIntercept */);
957 }
958
959 int32_t cClients = ASMAtomicDecS32(&pServer->mcClients);
960 if (cClients == 0)
961 {
962 /* Features which should be enabled only if there is a client. */
963 pServer->remote3DRedirect(false);
964 }
965}
966
967DECLCALLBACK(int) ConsoleVRDPServer::VRDPCallbackIntercept(void *pvCallback, uint32_t u32ClientId, uint32_t fu32Intercept,
968 void **ppvIntercept)
969{
970 ConsoleVRDPServer *pServer = static_cast<ConsoleVRDPServer*>(pvCallback);
971 AssertPtrReturn(pServer, VERR_INVALID_POINTER);
972
973 LogFlowFunc(("%x\n", fu32Intercept));
974
975 int rc = VERR_NOT_SUPPORTED;
976
977 switch (fu32Intercept)
978 {
979 case VRDE_CLIENT_INTERCEPT_AUDIO:
980 {
981 pServer->mConsole->i_VRDPInterceptAudio(u32ClientId);
982 if (ppvIntercept)
983 {
984 *ppvIntercept = pServer;
985 }
986 rc = VINF_SUCCESS;
987 } break;
988
989 case VRDE_CLIENT_INTERCEPT_USB:
990 {
991 pServer->mConsole->i_VRDPInterceptUSB(u32ClientId, ppvIntercept);
992 rc = VINF_SUCCESS;
993 } break;
994
995 case VRDE_CLIENT_INTERCEPT_CLIPBOARD:
996 {
997 pServer->mConsole->i_VRDPInterceptClipboard(u32ClientId);
998 if (ppvIntercept)
999 {
1000 *ppvIntercept = pServer;
1001 }
1002 rc = VINF_SUCCESS;
1003 } break;
1004
1005 case VRDE_CLIENT_INTERCEPT_AUDIO_INPUT:
1006 {
1007 /*
1008 * This request is processed internally by the ConsoleVRDPServer.
1009 * Only one client is allowed to intercept audio input.
1010 */
1011 if (ASMAtomicCmpXchgU32(&pServer->mu32AudioInputClientId, u32ClientId, 0) == true)
1012 {
1013 LogFunc(("Intercepting audio input by client %RU32\n", u32ClientId));
1014
1015 AudioVRDE *pVRDE = pServer->mConsole->i_getAudioVRDE();
1016 if (pVRDE)
1017 pVRDE->onVRDEInputIntercept(true /* fIntercept */);
1018 }
1019 else
1020 {
1021 Log(("AUDIOIN: ignored client %RU32, active client %RU32\n", u32ClientId, pServer->mu32AudioInputClientId));
1022 rc = VERR_NOT_SUPPORTED;
1023 }
1024 } break;
1025
1026 default:
1027 break;
1028 }
1029
1030 return rc;
1031}
1032
1033DECLCALLBACK(int) ConsoleVRDPServer::VRDPCallbackUSB(void *pvCallback, void *pvIntercept, uint32_t u32ClientId,
1034 uint8_t u8Code, const void *pvRet, uint32_t cbRet)
1035{
1036#ifdef VBOX_WITH_USB
1037 return USBClientResponseCallback(pvIntercept, u32ClientId, u8Code, pvRet, cbRet);
1038#else
1039 return VERR_NOT_SUPPORTED;
1040#endif
1041}
1042
1043DECLCALLBACK(int) ConsoleVRDPServer::VRDPCallbackClipboard(void *pvCallback, void *pvIntercept, uint32_t u32ClientId,
1044 uint32_t u32Function, uint32_t u32Format,
1045 const void *pvData, uint32_t cbData)
1046{
1047 return ClipboardCallback(pvIntercept, u32ClientId, u32Function, u32Format, pvData, cbData);
1048}
1049
1050DECLCALLBACK(bool) ConsoleVRDPServer::VRDPCallbackFramebufferQuery(void *pvCallback, unsigned uScreenId,
1051 VRDEFRAMEBUFFERINFO *pInfo)
1052{
1053 ConsoleVRDPServer *server = static_cast<ConsoleVRDPServer*>(pvCallback);
1054
1055 bool fAvailable = false;
1056
1057 /* Obtain the new screen bitmap. */
1058 HRESULT hr = server->mConsole->i_getDisplay()->QuerySourceBitmap(uScreenId, server->maSourceBitmaps[uScreenId].asOutParam());
1059 if (SUCCEEDED(hr))
1060 {
1061 LONG xOrigin = 0;
1062 LONG yOrigin = 0;
1063 BYTE *pAddress = NULL;
1064 ULONG ulWidth = 0;
1065 ULONG ulHeight = 0;
1066 ULONG ulBitsPerPixel = 0;
1067 ULONG ulBytesPerLine = 0;
1068 BitmapFormat_T bitmapFormat = BitmapFormat_Opaque;
1069
1070 hr = server->maSourceBitmaps[uScreenId]->QueryBitmapInfo(&pAddress,
1071 &ulWidth,
1072 &ulHeight,
1073 &ulBitsPerPixel,
1074 &ulBytesPerLine,
1075 &bitmapFormat);
1076
1077 if (SUCCEEDED(hr))
1078 {
1079 ULONG dummy;
1080 GuestMonitorStatus_T monitorStatus;
1081 hr = server->mConsole->i_getDisplay()->GetScreenResolution(uScreenId, &dummy, &dummy, &dummy,
1082 &xOrigin, &yOrigin, &monitorStatus);
1083
1084 if (SUCCEEDED(hr))
1085 {
1086 /* Now fill the information as requested by the caller. */
1087 pInfo->pu8Bits = pAddress;
1088 pInfo->xOrigin = xOrigin;
1089 pInfo->yOrigin = yOrigin;
1090 pInfo->cWidth = ulWidth;
1091 pInfo->cHeight = ulHeight;
1092 pInfo->cBitsPerPixel = ulBitsPerPixel;
1093 pInfo->cbLine = ulBytesPerLine;
1094
1095 fAvailable = true;
1096 }
1097 }
1098 }
1099
1100 return fAvailable;
1101}
1102
1103DECLCALLBACK(void) ConsoleVRDPServer::VRDPCallbackFramebufferLock(void *pvCallback, unsigned uScreenId)
1104{
1105 NOREF(pvCallback);
1106 NOREF(uScreenId);
1107 /* Do nothing */
1108}
1109
1110DECLCALLBACK(void) ConsoleVRDPServer::VRDPCallbackFramebufferUnlock(void *pvCallback, unsigned uScreenId)
1111{
1112 NOREF(pvCallback);
1113 NOREF(uScreenId);
1114 /* Do nothing */
1115}
1116
1117static void fixKbdLockStatus(VRDPInputSynch *pInputSynch, IKeyboard *pKeyboard)
1118{
1119 if ( pInputSynch->cGuestNumLockAdaptions
1120 && (pInputSynch->fGuestNumLock != pInputSynch->fClientNumLock))
1121 {
1122 pInputSynch->cGuestNumLockAdaptions--;
1123 pKeyboard->PutScancode(0x45);
1124 pKeyboard->PutScancode(0x45 | 0x80);
1125 }
1126 if ( pInputSynch->cGuestCapsLockAdaptions
1127 && (pInputSynch->fGuestCapsLock != pInputSynch->fClientCapsLock))
1128 {
1129 pInputSynch->cGuestCapsLockAdaptions--;
1130 pKeyboard->PutScancode(0x3a);
1131 pKeyboard->PutScancode(0x3a | 0x80);
1132 }
1133}
1134
1135DECLCALLBACK(void) ConsoleVRDPServer::VRDPCallbackInput(void *pvCallback, int type, const void *pvInput, unsigned cbInput)
1136{
1137 ConsoleVRDPServer *server = static_cast<ConsoleVRDPServer*>(pvCallback);
1138 Console *pConsole = server->mConsole;
1139
1140 switch (type)
1141 {
1142 case VRDE_INPUT_SCANCODE:
1143 {
1144 if (cbInput == sizeof(VRDEINPUTSCANCODE))
1145 {
1146 IKeyboard *pKeyboard = pConsole->i_getKeyboard();
1147
1148 const VRDEINPUTSCANCODE *pInputScancode = (VRDEINPUTSCANCODE *)pvInput;
1149
1150 /* Track lock keys. */
1151 if (pInputScancode->uScancode == 0x45)
1152 {
1153 server->m_InputSynch.fClientNumLock = !server->m_InputSynch.fClientNumLock;
1154 }
1155 else if (pInputScancode->uScancode == 0x3a)
1156 {
1157 server->m_InputSynch.fClientCapsLock = !server->m_InputSynch.fClientCapsLock;
1158 }
1159 else if (pInputScancode->uScancode == 0x46)
1160 {
1161 server->m_InputSynch.fClientScrollLock = !server->m_InputSynch.fClientScrollLock;
1162 }
1163 else if ((pInputScancode->uScancode & 0x80) == 0)
1164 {
1165 /* Key pressed. */
1166 fixKbdLockStatus(&server->m_InputSynch, pKeyboard);
1167 }
1168
1169 pKeyboard->PutScancode((LONG)pInputScancode->uScancode);
1170 }
1171 } break;
1172
1173 case VRDE_INPUT_POINT:
1174 {
1175 if (cbInput == sizeof(VRDEINPUTPOINT))
1176 {
1177 const VRDEINPUTPOINT *pInputPoint = (VRDEINPUTPOINT *)pvInput;
1178
1179 int mouseButtons = 0;
1180 int iWheel = 0;
1181
1182 if (pInputPoint->uButtons & VRDE_INPUT_POINT_BUTTON1)
1183 {
1184 mouseButtons |= MouseButtonState_LeftButton;
1185 }
1186 if (pInputPoint->uButtons & VRDE_INPUT_POINT_BUTTON2)
1187 {
1188 mouseButtons |= MouseButtonState_RightButton;
1189 }
1190 if (pInputPoint->uButtons & VRDE_INPUT_POINT_BUTTON3)
1191 {
1192 mouseButtons |= MouseButtonState_MiddleButton;
1193 }
1194 if (pInputPoint->uButtons & VRDE_INPUT_POINT_WHEEL_UP)
1195 {
1196 mouseButtons |= MouseButtonState_WheelUp;
1197 iWheel = -1;
1198 }
1199 if (pInputPoint->uButtons & VRDE_INPUT_POINT_WHEEL_DOWN)
1200 {
1201 mouseButtons |= MouseButtonState_WheelDown;
1202 iWheel = 1;
1203 }
1204
1205 if (server->m_fGuestWantsAbsolute)
1206 {
1207 pConsole->i_getMouse()->PutMouseEventAbsolute(pInputPoint->x + 1, pInputPoint->y + 1, iWheel,
1208 0 /* Horizontal wheel */, mouseButtons);
1209 } else
1210 {
1211 pConsole->i_getMouse()->PutMouseEvent(pInputPoint->x - server->m_mousex,
1212 pInputPoint->y - server->m_mousey,
1213 iWheel, 0 /* Horizontal wheel */, mouseButtons);
1214 server->m_mousex = pInputPoint->x;
1215 server->m_mousey = pInputPoint->y;
1216 }
1217 }
1218 } break;
1219
1220 case VRDE_INPUT_CAD:
1221 {
1222 pConsole->i_getKeyboard()->PutCAD();
1223 } break;
1224
1225 case VRDE_INPUT_RESET:
1226 {
1227 pConsole->Reset();
1228 } break;
1229
1230 case VRDE_INPUT_SYNCH:
1231 {
1232 if (cbInput == sizeof(VRDEINPUTSYNCH))
1233 {
1234 IKeyboard *pKeyboard = pConsole->i_getKeyboard();
1235
1236 const VRDEINPUTSYNCH *pInputSynch = (VRDEINPUTSYNCH *)pvInput;
1237
1238 server->m_InputSynch.fClientNumLock = (pInputSynch->uLockStatus & VRDE_INPUT_SYNCH_NUMLOCK) != 0;
1239 server->m_InputSynch.fClientCapsLock = (pInputSynch->uLockStatus & VRDE_INPUT_SYNCH_CAPITAL) != 0;
1240 server->m_InputSynch.fClientScrollLock = (pInputSynch->uLockStatus & VRDE_INPUT_SYNCH_SCROLL) != 0;
1241
1242 /* The client initiated synchronization. Always make the guest to reflect the client state.
1243 * Than means, when the guest changes the state itself, it is forced to return to the client
1244 * state.
1245 */
1246 if (server->m_InputSynch.fClientNumLock != server->m_InputSynch.fGuestNumLock)
1247 {
1248 server->m_InputSynch.cGuestNumLockAdaptions = 2;
1249 }
1250
1251 if (server->m_InputSynch.fClientCapsLock != server->m_InputSynch.fGuestCapsLock)
1252 {
1253 server->m_InputSynch.cGuestCapsLockAdaptions = 2;
1254 }
1255
1256 fixKbdLockStatus(&server->m_InputSynch, pKeyboard);
1257 }
1258 } break;
1259
1260 default:
1261 break;
1262 }
1263}
1264
1265DECLCALLBACK(void) ConsoleVRDPServer::VRDPCallbackVideoModeHint(void *pvCallback, unsigned cWidth, unsigned cHeight,
1266 unsigned cBitsPerPixel, unsigned uScreenId)
1267{
1268 ConsoleVRDPServer *server = static_cast<ConsoleVRDPServer*>(pvCallback);
1269
1270 server->mConsole->i_getDisplay()->SetVideoModeHint(uScreenId, TRUE /*=enabled*/,
1271 FALSE /*=changeOrigin*/, 0/*=OriginX*/, 0/*=OriginY*/,
1272 cWidth, cHeight, cBitsPerPixel);
1273}
1274
1275DECLCALLBACK(void) ConsoleVRDPServer::VRDECallbackAudioIn(void *pvCallback,
1276 void *pvCtx,
1277 uint32_t u32ClientId,
1278 uint32_t u32Event,
1279 const void *pvData,
1280 uint32_t cbData)
1281{
1282 ConsoleVRDPServer *pServer = static_cast<ConsoleVRDPServer*>(pvCallback);
1283 AssertPtrReturnVoid(pServer);
1284
1285 AudioVRDE *pVRDE = pServer->mConsole->i_getAudioVRDE();
1286 if (!pVRDE) /* Nothing to do, bail out early. */
1287 return;
1288
1289 switch (u32Event)
1290 {
1291 case VRDE_AUDIOIN_BEGIN:
1292 {
1293 pVRDE->onVRDEInputBegin(pvCtx, (PVRDEAUDIOINBEGIN)pvData);
1294 break;
1295 }
1296
1297 case VRDE_AUDIOIN_DATA:
1298 pVRDE->onVRDEInputData(pvCtx, pvData, cbData);
1299 break;
1300
1301 case VRDE_AUDIOIN_END:
1302 pVRDE->onVRDEInputEnd(pvCtx);
1303 break;
1304
1305 default:
1306 break;
1307 }
1308}
1309
1310ConsoleVRDPServer::ConsoleVRDPServer(Console *console)
1311{
1312 mConsole = console;
1313
1314 int rc = RTCritSectInit(&mCritSect);
1315 AssertRC(rc);
1316
1317 mcClipboardRefs = 0;
1318 mpfnClipboardCallback = NULL;
1319#ifdef VBOX_WITH_USB
1320 mUSBBackends.pHead = NULL;
1321 mUSBBackends.pTail = NULL;
1322
1323 mUSBBackends.thread = NIL_RTTHREAD;
1324 mUSBBackends.fThreadRunning = false;
1325 mUSBBackends.event = 0;
1326#endif
1327
1328 mhServer = 0;
1329 mServerInterfaceVersion = 0;
1330
1331 mcInResize = 0;
1332
1333 m_fGuestWantsAbsolute = false;
1334 m_mousex = 0;
1335 m_mousey = 0;
1336
1337 m_InputSynch.cGuestNumLockAdaptions = 2;
1338 m_InputSynch.cGuestCapsLockAdaptions = 2;
1339
1340 m_InputSynch.fGuestNumLock = false;
1341 m_InputSynch.fGuestCapsLock = false;
1342 m_InputSynch.fGuestScrollLock = false;
1343
1344 m_InputSynch.fClientNumLock = false;
1345 m_InputSynch.fClientCapsLock = false;
1346 m_InputSynch.fClientScrollLock = false;
1347
1348 {
1349 ComPtr<IEventSource> es;
1350 console->COMGETTER(EventSource)(es.asOutParam());
1351 ComObjPtr<VRDPConsoleListenerImpl> aConsoleListener;
1352 aConsoleListener.createObject();
1353 aConsoleListener->init(new VRDPConsoleListener(), this);
1354 mConsoleListener = aConsoleListener;
1355 com::SafeArray <VBoxEventType_T> eventTypes;
1356 eventTypes.push_back(VBoxEventType_OnMousePointerShapeChanged);
1357 eventTypes.push_back(VBoxEventType_OnMouseCapabilityChanged);
1358 eventTypes.push_back(VBoxEventType_OnKeyboardLedsChanged);
1359 es->RegisterListener(mConsoleListener, ComSafeArrayAsInParam(eventTypes), true);
1360 }
1361
1362 mVRDPBindPort = -1;
1363
1364 mAuthLibrary = 0;
1365
1366 mu32AudioInputClientId = 0;
1367 mcClients = 0;
1368
1369 /*
1370 * Optional interfaces.
1371 */
1372 m_fInterfaceImage = false;
1373 RT_ZERO(m_interfaceImage);
1374 RT_ZERO(m_interfaceCallbacksImage);
1375 RT_ZERO(m_interfaceMousePtr);
1376 RT_ZERO(m_interfaceSCard);
1377 RT_ZERO(m_interfaceCallbacksSCard);
1378 RT_ZERO(m_interfaceTSMF);
1379 RT_ZERO(m_interfaceCallbacksTSMF);
1380 RT_ZERO(m_interfaceVideoIn);
1381 RT_ZERO(m_interfaceCallbacksVideoIn);
1382 RT_ZERO(m_interfaceInput);
1383 RT_ZERO(m_interfaceCallbacksInput);
1384
1385 rc = RTCritSectInit(&mTSMFLock);
1386 AssertRC(rc);
1387
1388 mEmWebcam = new EmWebcam(this);
1389 AssertPtr(mEmWebcam);
1390}
1391
1392ConsoleVRDPServer::~ConsoleVRDPServer()
1393{
1394 Stop();
1395
1396 if (mConsoleListener)
1397 {
1398 ComPtr<IEventSource> es;
1399 mConsole->COMGETTER(EventSource)(es.asOutParam());
1400 es->UnregisterListener(mConsoleListener);
1401 mConsoleListener.setNull();
1402 }
1403
1404 unsigned i;
1405 for (i = 0; i < RT_ELEMENTS(maSourceBitmaps); i++)
1406 {
1407 maSourceBitmaps[i].setNull();
1408 }
1409
1410 if (mEmWebcam)
1411 {
1412 delete mEmWebcam;
1413 mEmWebcam = NULL;
1414 }
1415
1416 if (RTCritSectIsInitialized(&mCritSect))
1417 {
1418 RTCritSectDelete(&mCritSect);
1419 RT_ZERO(mCritSect);
1420 }
1421
1422 if (RTCritSectIsInitialized(&mTSMFLock))
1423 {
1424 RTCritSectDelete(&mTSMFLock);
1425 RT_ZERO(mTSMFLock);
1426 }
1427}
1428
1429int ConsoleVRDPServer::Launch(void)
1430{
1431 LogFlowThisFunc(("\n"));
1432
1433 IVRDEServer *server = mConsole->i_getVRDEServer();
1434 AssertReturn(server, VERR_INTERNAL_ERROR_2);
1435
1436 /*
1437 * Check if VRDE is enabled.
1438 */
1439 BOOL fEnabled;
1440 HRESULT hrc = server->COMGETTER(Enabled)(&fEnabled);
1441 AssertComRCReturn(hrc, Global::vboxStatusCodeFromCOM(hrc));
1442 if (!fEnabled)
1443 return VINF_SUCCESS;
1444
1445 /*
1446 * Check that a VRDE extension pack name is set and resolve it into a
1447 * library path.
1448 */
1449 Bstr bstrExtPack;
1450 hrc = server->COMGETTER(VRDEExtPack)(bstrExtPack.asOutParam());
1451 if (FAILED(hrc))
1452 return Global::vboxStatusCodeFromCOM(hrc);
1453 if (bstrExtPack.isEmpty())
1454 return VINF_NOT_SUPPORTED;
1455
1456 Utf8Str strExtPack(bstrExtPack);
1457 Utf8Str strVrdeLibrary;
1458 int vrc = VINF_SUCCESS;
1459 if (strExtPack.equals(VBOXVRDP_KLUDGE_EXTPACK_NAME))
1460 strVrdeLibrary = "VBoxVRDP";
1461 else
1462 {
1463#ifdef VBOX_WITH_EXTPACK
1464 ExtPackManager *pExtPackMgr = mConsole->i_getExtPackManager();
1465 vrc = pExtPackMgr->i_getVrdeLibraryPathForExtPack(&strExtPack, &strVrdeLibrary);
1466#else
1467 vrc = VERR_FILE_NOT_FOUND;
1468#endif
1469 }
1470 if (RT_SUCCESS(vrc))
1471 {
1472 /*
1473 * Load the VRDE library and start the server, if it is enabled.
1474 */
1475 vrc = loadVRDPLibrary(strVrdeLibrary.c_str());
1476 if (RT_SUCCESS(vrc))
1477 {
1478 VRDEENTRYPOINTS_4 *pEntryPoints4;
1479 vrc = mpfnVRDECreateServer(&mCallbacks.header, this, (VRDEINTERFACEHDR **)&pEntryPoints4, &mhServer);
1480
1481 if (RT_SUCCESS(vrc))
1482 {
1483 mServerInterfaceVersion = 4;
1484 mEntryPoints = *pEntryPoints4;
1485 mpEntryPoints = &mEntryPoints;
1486 }
1487 else if (vrc == VERR_VERSION_MISMATCH)
1488 {
1489 /* An older version of VRDE is installed, try version 3. */
1490 VRDEENTRYPOINTS_3 *pEntryPoints3;
1491
1492 static VRDECALLBACKS_3 sCallbacks3 =
1493 {
1494 { VRDE_INTERFACE_VERSION_3, sizeof(VRDECALLBACKS_3) },
1495 ConsoleVRDPServer::VRDPCallbackQueryProperty,
1496 ConsoleVRDPServer::VRDPCallbackClientLogon,
1497 ConsoleVRDPServer::VRDPCallbackClientConnect,
1498 ConsoleVRDPServer::VRDPCallbackClientDisconnect,
1499 ConsoleVRDPServer::VRDPCallbackIntercept,
1500 ConsoleVRDPServer::VRDPCallbackUSB,
1501 ConsoleVRDPServer::VRDPCallbackClipboard,
1502 ConsoleVRDPServer::VRDPCallbackFramebufferQuery,
1503 ConsoleVRDPServer::VRDPCallbackFramebufferLock,
1504 ConsoleVRDPServer::VRDPCallbackFramebufferUnlock,
1505 ConsoleVRDPServer::VRDPCallbackInput,
1506 ConsoleVRDPServer::VRDPCallbackVideoModeHint,
1507 ConsoleVRDPServer::VRDECallbackAudioIn
1508 };
1509
1510 vrc = mpfnVRDECreateServer(&sCallbacks3.header, this, (VRDEINTERFACEHDR **)&pEntryPoints3, &mhServer);
1511 if (RT_SUCCESS(vrc))
1512 {
1513 mServerInterfaceVersion = 3;
1514 mEntryPoints.header = pEntryPoints3->header;
1515 mEntryPoints.VRDEDestroy = pEntryPoints3->VRDEDestroy;
1516 mEntryPoints.VRDEEnableConnections = pEntryPoints3->VRDEEnableConnections;
1517 mEntryPoints.VRDEDisconnect = pEntryPoints3->VRDEDisconnect;
1518 mEntryPoints.VRDEResize = pEntryPoints3->VRDEResize;
1519 mEntryPoints.VRDEUpdate = pEntryPoints3->VRDEUpdate;
1520 mEntryPoints.VRDEColorPointer = pEntryPoints3->VRDEColorPointer;
1521 mEntryPoints.VRDEHidePointer = pEntryPoints3->VRDEHidePointer;
1522 mEntryPoints.VRDEAudioSamples = pEntryPoints3->VRDEAudioSamples;
1523 mEntryPoints.VRDEAudioVolume = pEntryPoints3->VRDEAudioVolume;
1524 mEntryPoints.VRDEUSBRequest = pEntryPoints3->VRDEUSBRequest;
1525 mEntryPoints.VRDEClipboard = pEntryPoints3->VRDEClipboard;
1526 mEntryPoints.VRDEQueryInfo = pEntryPoints3->VRDEQueryInfo;
1527 mEntryPoints.VRDERedirect = pEntryPoints3->VRDERedirect;
1528 mEntryPoints.VRDEAudioInOpen = pEntryPoints3->VRDEAudioInOpen;
1529 mEntryPoints.VRDEAudioInClose = pEntryPoints3->VRDEAudioInClose;
1530 mEntryPoints.VRDEGetInterface = NULL;
1531 mpEntryPoints = &mEntryPoints;
1532 }
1533 else if (vrc == VERR_VERSION_MISMATCH)
1534 {
1535 /* An older version of VRDE is installed, try version 1. */
1536 VRDEENTRYPOINTS_1 *pEntryPoints1;
1537
1538 static VRDECALLBACKS_1 sCallbacks1 =
1539 {
1540 { VRDE_INTERFACE_VERSION_1, sizeof(VRDECALLBACKS_1) },
1541 ConsoleVRDPServer::VRDPCallbackQueryProperty,
1542 ConsoleVRDPServer::VRDPCallbackClientLogon,
1543 ConsoleVRDPServer::VRDPCallbackClientConnect,
1544 ConsoleVRDPServer::VRDPCallbackClientDisconnect,
1545 ConsoleVRDPServer::VRDPCallbackIntercept,
1546 ConsoleVRDPServer::VRDPCallbackUSB,
1547 ConsoleVRDPServer::VRDPCallbackClipboard,
1548 ConsoleVRDPServer::VRDPCallbackFramebufferQuery,
1549 ConsoleVRDPServer::VRDPCallbackFramebufferLock,
1550 ConsoleVRDPServer::VRDPCallbackFramebufferUnlock,
1551 ConsoleVRDPServer::VRDPCallbackInput,
1552 ConsoleVRDPServer::VRDPCallbackVideoModeHint
1553 };
1554
1555 vrc = mpfnVRDECreateServer(&sCallbacks1.header, this, (VRDEINTERFACEHDR **)&pEntryPoints1, &mhServer);
1556 if (RT_SUCCESS(vrc))
1557 {
1558 mServerInterfaceVersion = 1;
1559 mEntryPoints.header = pEntryPoints1->header;
1560 mEntryPoints.VRDEDestroy = pEntryPoints1->VRDEDestroy;
1561 mEntryPoints.VRDEEnableConnections = pEntryPoints1->VRDEEnableConnections;
1562 mEntryPoints.VRDEDisconnect = pEntryPoints1->VRDEDisconnect;
1563 mEntryPoints.VRDEResize = pEntryPoints1->VRDEResize;
1564 mEntryPoints.VRDEUpdate = pEntryPoints1->VRDEUpdate;
1565 mEntryPoints.VRDEColorPointer = pEntryPoints1->VRDEColorPointer;
1566 mEntryPoints.VRDEHidePointer = pEntryPoints1->VRDEHidePointer;
1567 mEntryPoints.VRDEAudioSamples = pEntryPoints1->VRDEAudioSamples;
1568 mEntryPoints.VRDEAudioVolume = pEntryPoints1->VRDEAudioVolume;
1569 mEntryPoints.VRDEUSBRequest = pEntryPoints1->VRDEUSBRequest;
1570 mEntryPoints.VRDEClipboard = pEntryPoints1->VRDEClipboard;
1571 mEntryPoints.VRDEQueryInfo = pEntryPoints1->VRDEQueryInfo;
1572 mEntryPoints.VRDERedirect = NULL;
1573 mEntryPoints.VRDEAudioInOpen = NULL;
1574 mEntryPoints.VRDEAudioInClose = NULL;
1575 mEntryPoints.VRDEGetInterface = NULL;
1576 mpEntryPoints = &mEntryPoints;
1577 }
1578 }
1579 }
1580
1581 if (RT_SUCCESS(vrc))
1582 {
1583 LogRel(("VRDE: loaded version %d of the server.\n", mServerInterfaceVersion));
1584
1585 if (mServerInterfaceVersion >= 4)
1586 {
1587 /* The server supports optional interfaces. */
1588 Assert(mpEntryPoints->VRDEGetInterface != NULL);
1589
1590 /* Image interface. */
1591 m_interfaceImage.header.u64Version = 1;
1592 m_interfaceImage.header.u64Size = sizeof(m_interfaceImage);
1593
1594 m_interfaceCallbacksImage.header.u64Version = 1;
1595 m_interfaceCallbacksImage.header.u64Size = sizeof(m_interfaceCallbacksImage);
1596 m_interfaceCallbacksImage.VRDEImageCbNotify = VRDEImageCbNotify;
1597
1598 vrc = mpEntryPoints->VRDEGetInterface(mhServer,
1599 VRDE_IMAGE_INTERFACE_NAME,
1600 &m_interfaceImage.header,
1601 &m_interfaceCallbacksImage.header,
1602 this);
1603 if (RT_SUCCESS(vrc))
1604 {
1605 LogRel(("VRDE: [%s]\n", VRDE_IMAGE_INTERFACE_NAME));
1606 m_fInterfaceImage = true;
1607 }
1608
1609 /* Mouse pointer interface. */
1610 m_interfaceMousePtr.header.u64Version = 1;
1611 m_interfaceMousePtr.header.u64Size = sizeof(m_interfaceMousePtr);
1612
1613 vrc = mpEntryPoints->VRDEGetInterface(mhServer,
1614 VRDE_MOUSEPTR_INTERFACE_NAME,
1615 &m_interfaceMousePtr.header,
1616 NULL,
1617 this);
1618 if (RT_SUCCESS(vrc))
1619 {
1620 LogRel(("VRDE: [%s]\n", VRDE_MOUSEPTR_INTERFACE_NAME));
1621 }
1622 else
1623 {
1624 RT_ZERO(m_interfaceMousePtr);
1625 }
1626
1627 /* Smartcard interface. */
1628 m_interfaceSCard.header.u64Version = 1;
1629 m_interfaceSCard.header.u64Size = sizeof(m_interfaceSCard);
1630
1631 m_interfaceCallbacksSCard.header.u64Version = 1;
1632 m_interfaceCallbacksSCard.header.u64Size = sizeof(m_interfaceCallbacksSCard);
1633 m_interfaceCallbacksSCard.VRDESCardCbNotify = VRDESCardCbNotify;
1634 m_interfaceCallbacksSCard.VRDESCardCbResponse = VRDESCardCbResponse;
1635
1636 vrc = mpEntryPoints->VRDEGetInterface(mhServer,
1637 VRDE_SCARD_INTERFACE_NAME,
1638 &m_interfaceSCard.header,
1639 &m_interfaceCallbacksSCard.header,
1640 this);
1641 if (RT_SUCCESS(vrc))
1642 {
1643 LogRel(("VRDE: [%s]\n", VRDE_SCARD_INTERFACE_NAME));
1644 }
1645 else
1646 {
1647 RT_ZERO(m_interfaceSCard);
1648 }
1649
1650 /* Raw TSMF interface. */
1651 m_interfaceTSMF.header.u64Version = 1;
1652 m_interfaceTSMF.header.u64Size = sizeof(m_interfaceTSMF);
1653
1654 m_interfaceCallbacksTSMF.header.u64Version = 1;
1655 m_interfaceCallbacksTSMF.header.u64Size = sizeof(m_interfaceCallbacksTSMF);
1656 m_interfaceCallbacksTSMF.VRDETSMFCbNotify = VRDETSMFCbNotify;
1657
1658 vrc = mpEntryPoints->VRDEGetInterface(mhServer,
1659 VRDE_TSMF_INTERFACE_NAME,
1660 &m_interfaceTSMF.header,
1661 &m_interfaceCallbacksTSMF.header,
1662 this);
1663 if (RT_SUCCESS(vrc))
1664 {
1665 LogRel(("VRDE: [%s]\n", VRDE_TSMF_INTERFACE_NAME));
1666 }
1667 else
1668 {
1669 RT_ZERO(m_interfaceTSMF);
1670 }
1671
1672 /* VideoIn interface. */
1673 m_interfaceVideoIn.header.u64Version = 1;
1674 m_interfaceVideoIn.header.u64Size = sizeof(m_interfaceVideoIn);
1675
1676 m_interfaceCallbacksVideoIn.header.u64Version = 1;
1677 m_interfaceCallbacksVideoIn.header.u64Size = sizeof(m_interfaceCallbacksVideoIn);
1678 m_interfaceCallbacksVideoIn.VRDECallbackVideoInNotify = VRDECallbackVideoInNotify;
1679 m_interfaceCallbacksVideoIn.VRDECallbackVideoInDeviceDesc = VRDECallbackVideoInDeviceDesc;
1680 m_interfaceCallbacksVideoIn.VRDECallbackVideoInControl = VRDECallbackVideoInControl;
1681 m_interfaceCallbacksVideoIn.VRDECallbackVideoInFrame = VRDECallbackVideoInFrame;
1682
1683 vrc = mpEntryPoints->VRDEGetInterface(mhServer,
1684 VRDE_VIDEOIN_INTERFACE_NAME,
1685 &m_interfaceVideoIn.header,
1686 &m_interfaceCallbacksVideoIn.header,
1687 this);
1688 if (RT_SUCCESS(vrc))
1689 {
1690 LogRel(("VRDE: [%s]\n", VRDE_VIDEOIN_INTERFACE_NAME));
1691 }
1692 else
1693 {
1694 RT_ZERO(m_interfaceVideoIn);
1695 }
1696
1697 /* Input interface. */
1698 m_interfaceInput.header.u64Version = 1;
1699 m_interfaceInput.header.u64Size = sizeof(m_interfaceInput);
1700
1701 m_interfaceCallbacksInput.header.u64Version = 1;
1702 m_interfaceCallbacksInput.header.u64Size = sizeof(m_interfaceCallbacksInput);
1703 m_interfaceCallbacksInput.VRDECallbackInputSetup = VRDECallbackInputSetup;
1704 m_interfaceCallbacksInput.VRDECallbackInputEvent = VRDECallbackInputEvent;
1705
1706 vrc = mpEntryPoints->VRDEGetInterface(mhServer,
1707 VRDE_INPUT_INTERFACE_NAME,
1708 &m_interfaceInput.header,
1709 &m_interfaceCallbacksInput.header,
1710 this);
1711 if (RT_SUCCESS(vrc))
1712 {
1713 LogRel(("VRDE: [%s]\n", VRDE_INPUT_INTERFACE_NAME));
1714 }
1715 else
1716 {
1717 RT_ZERO(m_interfaceInput);
1718 }
1719
1720 /* Since these interfaces are optional, it is always a success here. */
1721 vrc = VINF_SUCCESS;
1722 }
1723#ifdef VBOX_WITH_USB
1724 remoteUSBThreadStart();
1725#endif
1726
1727 /*
1728 * Re-init the server current state, which is usually obtained from events.
1729 */
1730 fetchCurrentState();
1731 }
1732 else
1733 {
1734 if (vrc != VERR_NET_ADDRESS_IN_USE)
1735 LogRel(("VRDE: Could not start the server rc = %Rrc\n", vrc));
1736 /* Don't unload the lib, because it prevents us trying again or
1737 because there may be other users? */
1738 }
1739 }
1740 }
1741
1742 return vrc;
1743}
1744
1745void ConsoleVRDPServer::fetchCurrentState(void)
1746{
1747 ComPtr<IMousePointerShape> mps;
1748 mConsole->i_getMouse()->COMGETTER(PointerShape)(mps.asOutParam());
1749 if (!mps.isNull())
1750 {
1751 BOOL visible, alpha;
1752 ULONG hotX, hotY, width, height;
1753 com::SafeArray <BYTE> shape;
1754
1755 mps->COMGETTER(Visible)(&visible);
1756 mps->COMGETTER(Alpha)(&alpha);
1757 mps->COMGETTER(HotX)(&hotX);
1758 mps->COMGETTER(HotY)(&hotY);
1759 mps->COMGETTER(Width)(&width);
1760 mps->COMGETTER(Height)(&height);
1761 mps->COMGETTER(Shape)(ComSafeArrayAsOutParam(shape));
1762
1763 onMousePointerShapeChange(visible, alpha, hotX, hotY, width, height, ComSafeArrayAsInParam(shape));
1764 }
1765}
1766
1767typedef struct H3DORInstance
1768{
1769 ConsoleVRDPServer *pThis;
1770 HVRDEIMAGE hImageBitmap;
1771 int32_t x;
1772 int32_t y;
1773 uint32_t w;
1774 uint32_t h;
1775 bool fCreated;
1776 bool fFallback;
1777 bool fTopDown;
1778} H3DORInstance;
1779
1780#define H3DORLOG Log
1781
1782/* static */ DECLCALLBACK(void) ConsoleVRDPServer::H3DORBegin(const void *pvContext, void **ppvInstance,
1783 const char *pszFormat)
1784{
1785 H3DORLOG(("H3DORBegin: ctx %p [%s]\n", pvContext, pszFormat));
1786
1787 H3DORInstance *p = (H3DORInstance *)RTMemAlloc(sizeof(H3DORInstance));
1788
1789 if (p)
1790 {
1791 p->pThis = (ConsoleVRDPServer *)pvContext;
1792 p->hImageBitmap = NULL;
1793 p->x = 0;
1794 p->y = 0;
1795 p->w = 0;
1796 p->h = 0;
1797 p->fCreated = false;
1798 p->fFallback = false;
1799
1800 /* Host 3D service passes the actual format of data in this redirect instance.
1801 * That is what will be in the H3DORFrame's parameters pvData and cbData.
1802 */
1803 if (RTStrICmp(pszFormat, H3DOR_FMT_RGBA_TOPDOWN) == 0)
1804 {
1805 /* Accept it. */
1806 p->fTopDown = true;
1807 }
1808 else if (RTStrICmp(pszFormat, H3DOR_FMT_RGBA) == 0)
1809 {
1810 /* Accept it. */
1811 p->fTopDown = false;
1812 }
1813 else
1814 {
1815 RTMemFree(p);
1816 p = NULL;
1817 }
1818 }
1819
1820 H3DORLOG(("H3DORBegin: ins %p\n", p));
1821
1822 /* Caller checks this for NULL. */
1823 *ppvInstance = p;
1824}
1825
1826/* static */ DECLCALLBACK(void) ConsoleVRDPServer::H3DORGeometry(void *pvInstance,
1827 int32_t x, int32_t y, uint32_t w, uint32_t h)
1828{
1829 H3DORLOG(("H3DORGeometry: ins %p %d,%d %dx%d\n", pvInstance, x, y, w, h));
1830
1831 H3DORInstance *p = (H3DORInstance *)pvInstance;
1832 Assert(p);
1833 Assert(p->pThis);
1834
1835 /* @todo find out what to do if size changes to 0x0 from non zero */
1836 if (w == 0 || h == 0)
1837 {
1838 /* Do nothing. */
1839 return;
1840 }
1841
1842 RTRECT rect;
1843 rect.xLeft = x;
1844 rect.yTop = y;
1845 rect.xRight = x + w;
1846 rect.yBottom = y + h;
1847
1848 if (p->hImageBitmap)
1849 {
1850 /* An image handle has been already created,
1851 * check if it has the same size as the reported geometry.
1852 */
1853 if ( p->x == x
1854 && p->y == y
1855 && p->w == w
1856 && p->h == h)
1857 {
1858 H3DORLOG(("H3DORGeometry: geometry not changed\n"));
1859 /* Do nothing. Continue using the existing handle. */
1860 }
1861 else
1862 {
1863 int rc = p->fFallback?
1864 VERR_NOT_SUPPORTED: /* Try to go out of fallback mode. */
1865 p->pThis->m_interfaceImage.VRDEImageGeometrySet(p->hImageBitmap, &rect);
1866 if (RT_SUCCESS(rc))
1867 {
1868 p->x = x;
1869 p->y = y;
1870 p->w = w;
1871 p->h = h;
1872 }
1873 else
1874 {
1875 /* The handle must be recreated. Delete existing handle here. */
1876 p->pThis->m_interfaceImage.VRDEImageHandleClose(p->hImageBitmap);
1877 p->hImageBitmap = NULL;
1878 }
1879 }
1880 }
1881
1882 if (!p->hImageBitmap)
1883 {
1884 /* Create a new bitmap handle. */
1885 uint32_t u32ScreenId = 0; /* @todo clip to corresponding screens.
1886 * Clipping can be done here or in VRDP server.
1887 * If VRDP does clipping, then uScreenId parameter
1888 * is not necessary and coords must be global.
1889 * (have to check which coords are used in opengl service).
1890 * Since all VRDE API uses a ScreenId,
1891 * the clipping must be done here in ConsoleVRDPServer
1892 */
1893 uint32_t fu32CompletionFlags = 0;
1894 p->fFallback = false;
1895 int rc = p->pThis->m_interfaceImage.VRDEImageHandleCreate(p->pThis->mhServer,
1896 &p->hImageBitmap,
1897 p,
1898 u32ScreenId,
1899 VRDE_IMAGE_F_CREATE_CONTENT_3D
1900 | VRDE_IMAGE_F_CREATE_WINDOW,
1901 &rect,
1902 VRDE_IMAGE_FMT_ID_BITMAP_BGRA8,
1903 NULL,
1904 0,
1905 &fu32CompletionFlags);
1906 if (RT_FAILURE(rc))
1907 {
1908 /* No support for a 3D + WINDOW. Try bitmap updates. */
1909 H3DORLOG(("H3DORGeometry: Fallback to bitmaps\n"));
1910 fu32CompletionFlags = 0;
1911 p->fFallback = true;
1912 rc = p->pThis->m_interfaceImage.VRDEImageHandleCreate(p->pThis->mhServer,
1913 &p->hImageBitmap,
1914 p,
1915 u32ScreenId,
1916 0,
1917 &rect,
1918 VRDE_IMAGE_FMT_ID_BITMAP_BGRA8,
1919 NULL,
1920 0,
1921 &fu32CompletionFlags);
1922 }
1923
1924 H3DORLOG(("H3DORGeometry: Image handle create %Rrc, flags 0x%RX32\n", rc, fu32CompletionFlags));
1925
1926 if (RT_SUCCESS(rc))
1927 {
1928 p->x = x;
1929 p->y = y;
1930 p->w = w;
1931 p->h = h;
1932
1933 if ((fu32CompletionFlags & VRDE_IMAGE_F_COMPLETE_ASYNC) == 0)
1934 {
1935 p->fCreated = true;
1936 }
1937 }
1938 else
1939 {
1940 p->hImageBitmap = NULL;
1941 p->w = 0;
1942 p->h = 0;
1943 }
1944 }
1945
1946 H3DORLOG(("H3DORGeometry: ins %p completed\n", pvInstance));
1947}
1948
1949/* static */ DECLCALLBACK(void) ConsoleVRDPServer::H3DORVisibleRegion(void *pvInstance,
1950 uint32_t cRects, const RTRECT *paRects)
1951{
1952 H3DORLOG(("H3DORVisibleRegion: ins %p %d\n", pvInstance, cRects));
1953
1954 H3DORInstance *p = (H3DORInstance *)pvInstance;
1955 Assert(p);
1956 Assert(p->pThis);
1957
1958 if (cRects == 0)
1959 {
1960 /* Complete image is visible. */
1961 RTRECT rect;
1962 rect.xLeft = p->x;
1963 rect.yTop = p->y;
1964 rect.xRight = p->x + p->w;
1965 rect.yBottom = p->y + p->h;
1966 p->pThis->m_interfaceImage.VRDEImageRegionSet (p->hImageBitmap,
1967 1,
1968 &rect);
1969 }
1970 else
1971 {
1972 p->pThis->m_interfaceImage.VRDEImageRegionSet (p->hImageBitmap,
1973 cRects,
1974 paRects);
1975 }
1976
1977 H3DORLOG(("H3DORVisibleRegion: ins %p completed\n", pvInstance));
1978}
1979
1980/* static */ DECLCALLBACK(void) ConsoleVRDPServer::H3DORFrame(void *pvInstance,
1981 void *pvData, uint32_t cbData)
1982{
1983 H3DORLOG(("H3DORFrame: ins %p %p %d\n", pvInstance, pvData, cbData));
1984
1985 H3DORInstance *p = (H3DORInstance *)pvInstance;
1986 Assert(p);
1987 Assert(p->pThis);
1988
1989 /* Currently only a topdown BGR0 bitmap format is supported. */
1990 VRDEIMAGEBITMAP image;
1991
1992 image.cWidth = p->w;
1993 image.cHeight = p->h;
1994 image.pvData = pvData;
1995 image.cbData = cbData;
1996 image.pvScanLine0 = (uint8_t *)pvData + (p->h - 1) * p->w * 4;
1997 image.iScanDelta = 4 * p->w;
1998 if (p->fTopDown)
1999 {
2000 image.iScanDelta = -image.iScanDelta;
2001 }
2002
2003 p->pThis->m_interfaceImage.VRDEImageUpdate (p->hImageBitmap,
2004 p->x,
2005 p->y,
2006 p->w,
2007 p->h,
2008 &image,
2009 sizeof(VRDEIMAGEBITMAP));
2010
2011 H3DORLOG(("H3DORFrame: ins %p completed\n", pvInstance));
2012}
2013
2014/* static */ DECLCALLBACK(void) ConsoleVRDPServer::H3DOREnd(void *pvInstance)
2015{
2016 H3DORLOG(("H3DOREnd: ins %p\n", pvInstance));
2017
2018 H3DORInstance *p = (H3DORInstance *)pvInstance;
2019 Assert(p);
2020 Assert(p->pThis);
2021
2022 p->pThis->m_interfaceImage.VRDEImageHandleClose(p->hImageBitmap);
2023
2024 RTMemFree(p);
2025
2026 H3DORLOG(("H3DOREnd: ins %p completed\n", pvInstance));
2027}
2028
2029/* static */ DECLCALLBACK(int) ConsoleVRDPServer::H3DORContextProperty(const void *pvContext, uint32_t index,
2030 void *pvBuffer, uint32_t cbBuffer, uint32_t *pcbOut)
2031{
2032 int rc = VINF_SUCCESS;
2033
2034 H3DORLOG(("H3DORContextProperty: index %d\n", index));
2035
2036 if (index == H3DOR_PROP_FORMATS)
2037 {
2038 /* Return a comma separated list of supported formats. */
2039 uint32_t cbOut = (uint32_t)strlen(H3DOR_FMT_RGBA_TOPDOWN) + 1
2040 + (uint32_t)strlen(H3DOR_FMT_RGBA) + 1;
2041 if (cbOut <= cbBuffer)
2042 {
2043 char *pch = (char *)pvBuffer;
2044 memcpy(pch, H3DOR_FMT_RGBA_TOPDOWN, strlen(H3DOR_FMT_RGBA_TOPDOWN));
2045 pch += strlen(H3DOR_FMT_RGBA_TOPDOWN);
2046 *pch++ = ',';
2047 memcpy(pch, H3DOR_FMT_RGBA, strlen(H3DOR_FMT_RGBA));
2048 pch += strlen(H3DOR_FMT_RGBA);
2049 *pch++ = '\0';
2050 }
2051 else
2052 {
2053 rc = VERR_BUFFER_OVERFLOW;
2054 }
2055 *pcbOut = cbOut;
2056 }
2057 else
2058 {
2059 rc = VERR_NOT_SUPPORTED;
2060 }
2061
2062 H3DORLOG(("H3DORContextProperty: %Rrc\n", rc));
2063 return rc;
2064}
2065
2066void ConsoleVRDPServer::remote3DRedirect(bool fEnable)
2067{
2068 if (!m_fInterfaceImage)
2069 {
2070 /* No redirect without corresponding interface. */
2071 return;
2072 }
2073
2074 /* Check if 3D redirection has been enabled. It is enabled by default. */
2075 com::Bstr bstr;
2076 HRESULT hrc = mConsole->i_getVRDEServer()->GetVRDEProperty(Bstr("H3DRedirect/Enabled").raw(), bstr.asOutParam());
2077
2078 com::Utf8Str value = hrc == S_OK? bstr: "";
2079
2080 bool fAllowed = RTStrICmp(value.c_str(), "true") == 0
2081 || RTStrICmp(value.c_str(), "1") == 0
2082 || value.c_str()[0] == 0;
2083
2084 if (!fAllowed && fEnable)
2085 {
2086 return;
2087 }
2088
2089 /* Tell the host 3D service to redirect output using the ConsoleVRDPServer callbacks. */
2090 H3DOUTPUTREDIRECT outputRedirect =
2091 {
2092 this,
2093 H3DORBegin,
2094 H3DORGeometry,
2095 H3DORVisibleRegion,
2096 H3DORFrame,
2097 H3DOREnd,
2098 H3DORContextProperty
2099 };
2100
2101 if (!fEnable)
2102 {
2103 /* This will tell the service to disable rediection. */
2104 RT_ZERO(outputRedirect);
2105 }
2106
2107#if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
2108 VBOXCRCMDCTL_HGCM data;
2109 data.Hdr.enmType = VBOXCRCMDCTL_TYPE_HGCM;
2110 data.Hdr.u32Function = SHCRGL_HOST_FN_SET_OUTPUT_REDIRECT;
2111
2112 data.aParms[0].type = VBOX_HGCM_SVC_PARM_PTR;
2113 data.aParms[0].u.pointer.addr = &outputRedirect;
2114 data.aParms[0].u.pointer.size = sizeof(outputRedirect);
2115
2116 int rc = mConsole->i_getDisplay()->i_crCtlSubmitSync(&data.Hdr, sizeof (data));
2117 if (!RT_SUCCESS(rc))
2118 {
2119 Log(("SHCRGL_HOST_FN_SET_CONSOLE failed with %Rrc\n", rc));
2120 return;
2121 }
2122
2123 LogRel(("VRDE: %s 3D redirect.\n", fEnable? "Enabled": "Disabled"));
2124# ifdef DEBUG_misha
2125 AssertFailed();
2126# endif
2127#endif
2128
2129 return;
2130}
2131
2132/* static */ DECLCALLBACK(int) ConsoleVRDPServer::VRDEImageCbNotify (void *pvContext,
2133 void *pvUser,
2134 HVRDEIMAGE hVideo,
2135 uint32_t u32Id,
2136 void *pvData,
2137 uint32_t cbData)
2138{
2139 H3DORLOG(("H3DOR: VRDEImageCbNotify: pvContext %p, pvUser %p, hVideo %p, u32Id %u, pvData %p, cbData %d\n",
2140 pvContext, pvUser, hVideo, u32Id, pvData, cbData));
2141
2142 ConsoleVRDPServer *pServer = static_cast<ConsoleVRDPServer*>(pvContext);
2143 H3DORInstance *p = (H3DORInstance *)pvUser;
2144 Assert(p);
2145 Assert(p->pThis);
2146 Assert(p->pThis == pServer);
2147
2148 if (u32Id == VRDE_IMAGE_NOTIFY_HANDLE_CREATE)
2149 {
2150 if (cbData != sizeof(uint32_t))
2151 {
2152 AssertFailed();
2153 return VERR_INVALID_PARAMETER;
2154 }
2155
2156 uint32_t u32StreamId = *(uint32_t *)pvData;
2157 H3DORLOG(("H3DOR: VRDE_IMAGE_NOTIFY_HANDLE_CREATE u32StreamId %d\n",
2158 u32StreamId));
2159
2160 if (u32StreamId != 0)
2161 {
2162 p->fCreated = true; // @todo not needed?
2163 }
2164 else
2165 {
2166 /* The stream has not been created. */
2167 }
2168 }
2169
2170 return VINF_SUCCESS;
2171}
2172
2173#undef H3DORLOG
2174
2175/* static */ DECLCALLBACK(int) ConsoleVRDPServer::VRDESCardCbNotify(void *pvContext,
2176 uint32_t u32Id,
2177 void *pvData,
2178 uint32_t cbData)
2179{
2180#ifdef VBOX_WITH_USB_CARDREADER
2181 ConsoleVRDPServer *pThis = static_cast<ConsoleVRDPServer*>(pvContext);
2182 UsbCardReader *pReader = pThis->mConsole->i_getUsbCardReader();
2183 return pReader->VRDENotify(u32Id, pvData, cbData);
2184#else
2185 NOREF(pvContext);
2186 NOREF(u32Id);
2187 NOREF(pvData);
2188 NOREF(cbData);
2189 return VERR_NOT_SUPPORTED;
2190#endif
2191}
2192
2193/* static */ DECLCALLBACK(int) ConsoleVRDPServer::VRDESCardCbResponse(void *pvContext,
2194 int rcRequest,
2195 void *pvUser,
2196 uint32_t u32Function,
2197 void *pvData,
2198 uint32_t cbData)
2199{
2200#ifdef VBOX_WITH_USB_CARDREADER
2201 ConsoleVRDPServer *pThis = static_cast<ConsoleVRDPServer*>(pvContext);
2202 UsbCardReader *pReader = pThis->mConsole->i_getUsbCardReader();
2203 return pReader->VRDEResponse(rcRequest, pvUser, u32Function, pvData, cbData);
2204#else
2205 NOREF(pvContext);
2206 NOREF(rcRequest);
2207 NOREF(pvUser);
2208 NOREF(u32Function);
2209 NOREF(pvData);
2210 NOREF(cbData);
2211 return VERR_NOT_SUPPORTED;
2212#endif
2213}
2214
2215int ConsoleVRDPServer::SCardRequest(void *pvUser, uint32_t u32Function, const void *pvData, uint32_t cbData)
2216{
2217 int rc = VINF_SUCCESS;
2218
2219 if (mhServer && mpEntryPoints && m_interfaceSCard.VRDESCardRequest)
2220 {
2221 rc = m_interfaceSCard.VRDESCardRequest(mhServer, pvUser, u32Function, pvData, cbData);
2222 }
2223 else
2224 {
2225 rc = VERR_NOT_SUPPORTED;
2226 }
2227
2228 return rc;
2229}
2230
2231
2232struct TSMFHOSTCHCTX;
2233struct TSMFVRDPCTX;
2234
2235typedef struct TSMFHOSTCHCTX
2236{
2237 ConsoleVRDPServer *pThis;
2238
2239 struct TSMFVRDPCTX *pVRDPCtx; /* NULL if no corresponding host channel context. */
2240
2241 void *pvDataReceived;
2242 uint32_t cbDataReceived;
2243 uint32_t cbDataAllocated;
2244} TSMFHOSTCHCTX;
2245
2246typedef struct TSMFVRDPCTX
2247{
2248 ConsoleVRDPServer *pThis;
2249
2250 VBOXHOSTCHANNELCALLBACKS *pCallbacks;
2251 void *pvCallbacks;
2252
2253 TSMFHOSTCHCTX *pHostChCtx; /* NULL if no corresponding host channel context. */
2254
2255 uint32_t u32ChannelHandle;
2256} TSMFVRDPCTX;
2257
2258static int tsmfContextsAlloc(TSMFHOSTCHCTX **ppHostChCtx, TSMFVRDPCTX **ppVRDPCtx)
2259{
2260 TSMFHOSTCHCTX *pHostChCtx = (TSMFHOSTCHCTX *)RTMemAllocZ(sizeof(TSMFHOSTCHCTX));
2261 if (!pHostChCtx)
2262 {
2263 return VERR_NO_MEMORY;
2264 }
2265
2266 TSMFVRDPCTX *pVRDPCtx = (TSMFVRDPCTX *)RTMemAllocZ(sizeof(TSMFVRDPCTX));
2267 if (!pVRDPCtx)
2268 {
2269 RTMemFree(pHostChCtx);
2270 return VERR_NO_MEMORY;
2271 }
2272
2273 *ppHostChCtx = pHostChCtx;
2274 *ppVRDPCtx = pVRDPCtx;
2275 return VINF_SUCCESS;
2276}
2277
2278int ConsoleVRDPServer::tsmfLock(void)
2279{
2280 int rc = RTCritSectEnter(&mTSMFLock);
2281 AssertRC(rc);
2282 return rc;
2283}
2284
2285void ConsoleVRDPServer::tsmfUnlock(void)
2286{
2287 RTCritSectLeave(&mTSMFLock);
2288}
2289
2290/* static */ DECLCALLBACK(int) ConsoleVRDPServer::tsmfHostChannelAttach(void *pvProvider,
2291 void **ppvChannel,
2292 uint32_t u32Flags,
2293 VBOXHOSTCHANNELCALLBACKS *pCallbacks,
2294 void *pvCallbacks)
2295{
2296 LogFlowFunc(("\n"));
2297
2298 ConsoleVRDPServer *pThis = static_cast<ConsoleVRDPServer*>(pvProvider);
2299
2300 /* Create 2 context structures: for the VRDP server and for the host service. */
2301 TSMFHOSTCHCTX *pHostChCtx = NULL;
2302 TSMFVRDPCTX *pVRDPCtx = NULL;
2303
2304 int rc = tsmfContextsAlloc(&pHostChCtx, &pVRDPCtx);
2305 if (RT_FAILURE(rc))
2306 {
2307 return rc;
2308 }
2309
2310 pHostChCtx->pThis = pThis;
2311 pHostChCtx->pVRDPCtx = pVRDPCtx;
2312
2313 pVRDPCtx->pThis = pThis;
2314 pVRDPCtx->pCallbacks = pCallbacks;
2315 pVRDPCtx->pvCallbacks = pvCallbacks;
2316 pVRDPCtx->pHostChCtx = pHostChCtx;
2317
2318 rc = pThis->m_interfaceTSMF.VRDETSMFChannelCreate(pThis->mhServer, pVRDPCtx, u32Flags);
2319
2320 if (RT_SUCCESS(rc))
2321 {
2322 /* @todo contexts should be in a list for accounting. */
2323 *ppvChannel = pHostChCtx;
2324 }
2325 else
2326 {
2327 RTMemFree(pHostChCtx);
2328 RTMemFree(pVRDPCtx);
2329 }
2330
2331 return rc;
2332}
2333
2334/* static */ DECLCALLBACK(void) ConsoleVRDPServer::tsmfHostChannelDetach(void *pvChannel)
2335{
2336 LogFlowFunc(("\n"));
2337
2338 TSMFHOSTCHCTX *pHostChCtx = (TSMFHOSTCHCTX *)pvChannel;
2339 ConsoleVRDPServer *pThis = pHostChCtx->pThis;
2340
2341 int rc = pThis->tsmfLock();
2342 if (RT_SUCCESS(rc))
2343 {
2344 bool fClose = false;
2345 uint32_t u32ChannelHandle = 0;
2346
2347 if (pHostChCtx->pVRDPCtx)
2348 {
2349 /* There is still a VRDP context for this channel. */
2350 pHostChCtx->pVRDPCtx->pHostChCtx = NULL;
2351 u32ChannelHandle = pHostChCtx->pVRDPCtx->u32ChannelHandle;
2352 fClose = true;
2353 }
2354
2355 pThis->tsmfUnlock();
2356
2357 RTMemFree(pHostChCtx);
2358
2359 if (fClose)
2360 {
2361 LogFlowFunc(("Closing VRDE channel %d.\n", u32ChannelHandle));
2362 pThis->m_interfaceTSMF.VRDETSMFChannelClose(pThis->mhServer, u32ChannelHandle);
2363 }
2364 else
2365 {
2366 LogFlowFunc(("No VRDE channel.\n"));
2367 }
2368 }
2369}
2370
2371/* static */ DECLCALLBACK(int) ConsoleVRDPServer::tsmfHostChannelSend(void *pvChannel,
2372 const void *pvData,
2373 uint32_t cbData)
2374{
2375 LogFlowFunc(("cbData %d\n", cbData));
2376
2377 TSMFHOSTCHCTX *pHostChCtx = (TSMFHOSTCHCTX *)pvChannel;
2378 ConsoleVRDPServer *pThis = pHostChCtx->pThis;
2379
2380 int rc = pThis->tsmfLock();
2381 if (RT_SUCCESS(rc))
2382 {
2383 bool fSend = false;
2384 uint32_t u32ChannelHandle = 0;
2385
2386 if (pHostChCtx->pVRDPCtx)
2387 {
2388 u32ChannelHandle = pHostChCtx->pVRDPCtx->u32ChannelHandle;
2389 fSend = true;
2390 }
2391
2392 pThis->tsmfUnlock();
2393
2394 if (fSend)
2395 {
2396 LogFlowFunc(("Send to VRDE channel %d.\n", u32ChannelHandle));
2397 rc = pThis->m_interfaceTSMF.VRDETSMFChannelSend(pThis->mhServer, u32ChannelHandle,
2398 pvData, cbData);
2399 }
2400 }
2401
2402 return rc;
2403}
2404
2405/* static */ DECLCALLBACK(int) ConsoleVRDPServer::tsmfHostChannelRecv(void *pvChannel,
2406 void *pvData,
2407 uint32_t cbData,
2408 uint32_t *pcbReceived,
2409 uint32_t *pcbRemaining)
2410{
2411 LogFlowFunc(("cbData %d\n", cbData));
2412
2413 TSMFHOSTCHCTX *pHostChCtx = (TSMFHOSTCHCTX *)pvChannel;
2414 ConsoleVRDPServer *pThis = pHostChCtx->pThis;
2415
2416 int rc = pThis->tsmfLock();
2417 if (RT_SUCCESS(rc))
2418 {
2419 uint32_t cbToCopy = RT_MIN(cbData, pHostChCtx->cbDataReceived);
2420 uint32_t cbRemaining = pHostChCtx->cbDataReceived - cbToCopy;
2421
2422 LogFlowFunc(("cbToCopy %d, cbRemaining %d\n", cbToCopy, cbRemaining));
2423
2424 if (cbToCopy != 0)
2425 {
2426 memcpy(pvData, pHostChCtx->pvDataReceived, cbToCopy);
2427
2428 if (cbRemaining != 0)
2429 {
2430 memmove(pHostChCtx->pvDataReceived, (uint8_t *)pHostChCtx->pvDataReceived + cbToCopy, cbRemaining);
2431 }
2432
2433 pHostChCtx->cbDataReceived = cbRemaining;
2434 }
2435
2436 pThis->tsmfUnlock();
2437
2438 *pcbRemaining = cbRemaining;
2439 *pcbReceived = cbToCopy;
2440 }
2441
2442 return rc;
2443}
2444
2445/* static */ DECLCALLBACK(int) ConsoleVRDPServer::tsmfHostChannelControl(void *pvChannel,
2446 uint32_t u32Code,
2447 const void *pvParm,
2448 uint32_t cbParm,
2449 const void *pvData,
2450 uint32_t cbData,
2451 uint32_t *pcbDataReturned)
2452{
2453 LogFlowFunc(("u32Code %u\n", u32Code));
2454
2455 if (!pvChannel)
2456 {
2457 /* Special case, the provider must answer rather than a channel instance. */
2458 if (u32Code == VBOX_HOST_CHANNEL_CTRL_EXISTS)
2459 {
2460 *pcbDataReturned = 0;
2461 return VINF_SUCCESS;
2462 }
2463
2464 return VERR_NOT_IMPLEMENTED;
2465 }
2466
2467 /* Channels do not support this. */
2468 return VERR_NOT_IMPLEMENTED;
2469}
2470
2471
2472void ConsoleVRDPServer::setupTSMF(void)
2473{
2474 if (m_interfaceTSMF.header.u64Size == 0)
2475 {
2476 return;
2477 }
2478
2479 /* Register with the host channel service. */
2480 VBOXHOSTCHANNELINTERFACE hostChannelInterface =
2481 {
2482 this,
2483 tsmfHostChannelAttach,
2484 tsmfHostChannelDetach,
2485 tsmfHostChannelSend,
2486 tsmfHostChannelRecv,
2487 tsmfHostChannelControl
2488 };
2489
2490 VBoxHostChannelHostRegister parms;
2491
2492 static char szProviderName[] = "/vrde/tsmf";
2493
2494 parms.name.type = VBOX_HGCM_SVC_PARM_PTR;
2495 parms.name.u.pointer.addr = &szProviderName[0];
2496 parms.name.u.pointer.size = sizeof(szProviderName);
2497
2498 parms.iface.type = VBOX_HGCM_SVC_PARM_PTR;
2499 parms.iface.u.pointer.addr = &hostChannelInterface;
2500 parms.iface.u.pointer.size = sizeof(hostChannelInterface);
2501
2502 VMMDev *pVMMDev = mConsole->i_getVMMDev();
2503
2504 if (!pVMMDev)
2505 {
2506 AssertMsgFailed(("setupTSMF no vmmdev\n"));
2507 return;
2508 }
2509
2510 int rc = pVMMDev->hgcmHostCall("VBoxHostChannel",
2511 VBOX_HOST_CHANNEL_HOST_FN_REGISTER,
2512 2,
2513 &parms.name);
2514
2515 if (!RT_SUCCESS(rc))
2516 {
2517 Log(("VBOX_HOST_CHANNEL_HOST_FN_REGISTER failed with %Rrc\n", rc));
2518 return;
2519 }
2520
2521 LogRel(("VRDE: Enabled TSMF channel.\n"));
2522
2523 return;
2524}
2525
2526/* @todo these defines must be in a header, which is used by guest component as well. */
2527#define VBOX_TSMF_HCH_CREATE_ACCEPTED (VBOX_HOST_CHANNEL_EVENT_USER + 0)
2528#define VBOX_TSMF_HCH_CREATE_DECLINED (VBOX_HOST_CHANNEL_EVENT_USER + 1)
2529#define VBOX_TSMF_HCH_DISCONNECTED (VBOX_HOST_CHANNEL_EVENT_USER + 2)
2530
2531/* static */ DECLCALLBACK(void) ConsoleVRDPServer::VRDETSMFCbNotify(void *pvContext,
2532 uint32_t u32Notification,
2533 void *pvChannel,
2534 const void *pvParm,
2535 uint32_t cbParm)
2536{
2537 int rc = VINF_SUCCESS;
2538
2539 ConsoleVRDPServer *pThis = static_cast<ConsoleVRDPServer*>(pvContext);
2540
2541 TSMFVRDPCTX *pVRDPCtx = (TSMFVRDPCTX *)pvChannel;
2542
2543 Assert(pVRDPCtx->pThis == pThis);
2544
2545 if (pVRDPCtx->pCallbacks == NULL)
2546 {
2547 LogFlowFunc(("tsmfHostChannel: Channel disconnected. Skipping.\n"));
2548 return;
2549 }
2550
2551 switch (u32Notification)
2552 {
2553 case VRDE_TSMF_N_CREATE_ACCEPTED:
2554 {
2555 VRDETSMFNOTIFYCREATEACCEPTED *p = (VRDETSMFNOTIFYCREATEACCEPTED *)pvParm;
2556 Assert(cbParm == sizeof(VRDETSMFNOTIFYCREATEACCEPTED));
2557
2558 LogFlowFunc(("tsmfHostChannel: VRDE_TSMF_N_CREATE_ACCEPTED(%p): p->u32ChannelHandle %d\n",
2559 pVRDPCtx, p->u32ChannelHandle));
2560
2561 pVRDPCtx->u32ChannelHandle = p->u32ChannelHandle;
2562
2563 pVRDPCtx->pCallbacks->HostChannelCallbackEvent(pVRDPCtx->pvCallbacks, pVRDPCtx->pHostChCtx,
2564 VBOX_TSMF_HCH_CREATE_ACCEPTED,
2565 NULL, 0);
2566 } break;
2567
2568 case VRDE_TSMF_N_CREATE_DECLINED:
2569 {
2570 LogFlowFunc(("tsmfHostChannel: VRDE_TSMF_N_CREATE_DECLINED(%p)\n", pVRDPCtx));
2571
2572 pVRDPCtx->pCallbacks->HostChannelCallbackEvent(pVRDPCtx->pvCallbacks, pVRDPCtx->pHostChCtx,
2573 VBOX_TSMF_HCH_CREATE_DECLINED,
2574 NULL, 0);
2575 } break;
2576
2577 case VRDE_TSMF_N_DATA:
2578 {
2579 /* Save the data in the intermediate buffer and send the event. */
2580 VRDETSMFNOTIFYDATA *p = (VRDETSMFNOTIFYDATA *)pvParm;
2581 Assert(cbParm == sizeof(VRDETSMFNOTIFYDATA));
2582
2583 LogFlowFunc(("tsmfHostChannel: VRDE_TSMF_N_DATA(%p): p->cbData %d\n", pVRDPCtx, p->cbData));
2584
2585 VBOXHOSTCHANNELEVENTRECV ev;
2586 ev.u32SizeAvailable = 0;
2587
2588 rc = pThis->tsmfLock();
2589
2590 if (RT_SUCCESS(rc))
2591 {
2592 TSMFHOSTCHCTX *pHostChCtx = pVRDPCtx->pHostChCtx;
2593
2594 if (pHostChCtx)
2595 {
2596 if (pHostChCtx->pvDataReceived)
2597 {
2598 uint32_t cbAlloc = p->cbData + pHostChCtx->cbDataReceived;
2599 pHostChCtx->pvDataReceived = RTMemRealloc(pHostChCtx->pvDataReceived, cbAlloc);
2600 memcpy((uint8_t *)pHostChCtx->pvDataReceived + pHostChCtx->cbDataReceived, p->pvData, p->cbData);
2601
2602 pHostChCtx->cbDataReceived += p->cbData;
2603 pHostChCtx->cbDataAllocated = cbAlloc;
2604 }
2605 else
2606 {
2607 pHostChCtx->pvDataReceived = RTMemAlloc(p->cbData);
2608 memcpy(pHostChCtx->pvDataReceived, p->pvData, p->cbData);
2609
2610 pHostChCtx->cbDataReceived = p->cbData;
2611 pHostChCtx->cbDataAllocated = p->cbData;
2612 }
2613
2614 ev.u32SizeAvailable = p->cbData;
2615 }
2616 else
2617 {
2618 LogFlowFunc(("tsmfHostChannel: VRDE_TSMF_N_DATA: no host channel. Skipping\n"));
2619 }
2620
2621 pThis->tsmfUnlock();
2622 }
2623
2624 pVRDPCtx->pCallbacks->HostChannelCallbackEvent(pVRDPCtx->pvCallbacks, pVRDPCtx->pHostChCtx,
2625 VBOX_HOST_CHANNEL_EVENT_RECV,
2626 &ev, sizeof(ev));
2627 } break;
2628
2629 case VRDE_TSMF_N_DISCONNECTED:
2630 {
2631 LogFlowFunc(("tsmfHostChannel: VRDE_TSMF_N_DISCONNECTED(%p)\n", pVRDPCtx));
2632
2633 pVRDPCtx->pCallbacks->HostChannelCallbackEvent(pVRDPCtx->pvCallbacks, pVRDPCtx->pHostChCtx,
2634 VBOX_TSMF_HCH_DISCONNECTED,
2635 NULL, 0);
2636
2637 /* The callback context will not be used anymore. */
2638 pVRDPCtx->pCallbacks->HostChannelCallbackDeleted(pVRDPCtx->pvCallbacks, pVRDPCtx->pHostChCtx);
2639 pVRDPCtx->pCallbacks = NULL;
2640 pVRDPCtx->pvCallbacks = NULL;
2641
2642 rc = pThis->tsmfLock();
2643 if (RT_SUCCESS(rc))
2644 {
2645 if (pVRDPCtx->pHostChCtx)
2646 {
2647 /* There is still a host channel context for this channel. */
2648 pVRDPCtx->pHostChCtx->pVRDPCtx = NULL;
2649 }
2650
2651 pThis->tsmfUnlock();
2652
2653 RT_ZERO(*pVRDPCtx);
2654 RTMemFree(pVRDPCtx);
2655 }
2656 } break;
2657
2658 default:
2659 {
2660 AssertFailed();
2661 } break;
2662 }
2663}
2664
2665/* static */ DECLCALLBACK(void) ConsoleVRDPServer::VRDECallbackVideoInNotify(void *pvCallback,
2666 uint32_t u32Id,
2667 const void *pvData,
2668 uint32_t cbData)
2669{
2670 ConsoleVRDPServer *pThis = static_cast<ConsoleVRDPServer*>(pvCallback);
2671 if (pThis->mEmWebcam)
2672 {
2673 pThis->mEmWebcam->EmWebcamCbNotify(u32Id, pvData, cbData);
2674 }
2675}
2676
2677/* static */ DECLCALLBACK(void) ConsoleVRDPServer::VRDECallbackVideoInDeviceDesc(void *pvCallback,
2678 int rcRequest,
2679 void *pDeviceCtx,
2680 void *pvUser,
2681 const VRDEVIDEOINDEVICEDESC *pDeviceDesc,
2682 uint32_t cbDevice)
2683{
2684 ConsoleVRDPServer *pThis = static_cast<ConsoleVRDPServer*>(pvCallback);
2685 if (pThis->mEmWebcam)
2686 {
2687 pThis->mEmWebcam->EmWebcamCbDeviceDesc(rcRequest, pDeviceCtx, pvUser, pDeviceDesc, cbDevice);
2688 }
2689}
2690
2691/* static */ DECLCALLBACK(void) ConsoleVRDPServer::VRDECallbackVideoInControl(void *pvCallback,
2692 int rcRequest,
2693 void *pDeviceCtx,
2694 void *pvUser,
2695 const VRDEVIDEOINCTRLHDR *pControl,
2696 uint32_t cbControl)
2697{
2698 ConsoleVRDPServer *pThis = static_cast<ConsoleVRDPServer*>(pvCallback);
2699 if (pThis->mEmWebcam)
2700 {
2701 pThis->mEmWebcam->EmWebcamCbControl(rcRequest, pDeviceCtx, pvUser, pControl, cbControl);
2702 }
2703}
2704
2705/* static */ DECLCALLBACK(void) ConsoleVRDPServer::VRDECallbackVideoInFrame(void *pvCallback,
2706 int rcRequest,
2707 void *pDeviceCtx,
2708 const VRDEVIDEOINPAYLOADHDR *pFrame,
2709 uint32_t cbFrame)
2710{
2711 ConsoleVRDPServer *pThis = static_cast<ConsoleVRDPServer*>(pvCallback);
2712 if (pThis->mEmWebcam)
2713 {
2714 pThis->mEmWebcam->EmWebcamCbFrame(rcRequest, pDeviceCtx, pFrame, cbFrame);
2715 }
2716}
2717
2718int ConsoleVRDPServer::VideoInDeviceAttach(const VRDEVIDEOINDEVICEHANDLE *pDeviceHandle, void *pvDeviceCtx)
2719{
2720 int rc;
2721
2722 if (mhServer && mpEntryPoints && m_interfaceVideoIn.VRDEVideoInDeviceAttach)
2723 {
2724 rc = m_interfaceVideoIn.VRDEVideoInDeviceAttach(mhServer, pDeviceHandle, pvDeviceCtx);
2725 }
2726 else
2727 {
2728 rc = VERR_NOT_SUPPORTED;
2729 }
2730
2731 return rc;
2732}
2733
2734int ConsoleVRDPServer::VideoInDeviceDetach(const VRDEVIDEOINDEVICEHANDLE *pDeviceHandle)
2735{
2736 int rc;
2737
2738 if (mhServer && mpEntryPoints && m_interfaceVideoIn.VRDEVideoInDeviceDetach)
2739 {
2740 rc = m_interfaceVideoIn.VRDEVideoInDeviceDetach(mhServer, pDeviceHandle);
2741 }
2742 else
2743 {
2744 rc = VERR_NOT_SUPPORTED;
2745 }
2746
2747 return rc;
2748}
2749
2750int ConsoleVRDPServer::VideoInGetDeviceDesc(void *pvUser, const VRDEVIDEOINDEVICEHANDLE *pDeviceHandle)
2751{
2752 int rc;
2753
2754 if (mhServer && mpEntryPoints && m_interfaceVideoIn.VRDEVideoInGetDeviceDesc)
2755 {
2756 rc = m_interfaceVideoIn.VRDEVideoInGetDeviceDesc(mhServer, pvUser, pDeviceHandle);
2757 }
2758 else
2759 {
2760 rc = VERR_NOT_SUPPORTED;
2761 }
2762
2763 return rc;
2764}
2765
2766int ConsoleVRDPServer::VideoInControl(void *pvUser, const VRDEVIDEOINDEVICEHANDLE *pDeviceHandle,
2767 const VRDEVIDEOINCTRLHDR *pReq, uint32_t cbReq)
2768{
2769 int rc;
2770
2771 if (mhServer && mpEntryPoints && m_interfaceVideoIn.VRDEVideoInControl)
2772 {
2773 rc = m_interfaceVideoIn.VRDEVideoInControl(mhServer, pvUser, pDeviceHandle, pReq, cbReq);
2774 }
2775 else
2776 {
2777 rc = VERR_NOT_SUPPORTED;
2778 }
2779
2780 return rc;
2781}
2782
2783
2784/* static */ DECLCALLBACK(void) ConsoleVRDPServer::VRDECallbackInputSetup(void *pvCallback,
2785 int rcRequest,
2786 uint32_t u32Method,
2787 const void *pvResult,
2788 uint32_t cbResult)
2789{
2790 NOREF(pvCallback);
2791 NOREF(rcRequest);
2792 NOREF(u32Method);
2793 NOREF(pvResult);
2794 NOREF(cbResult);
2795}
2796
2797/* static */ DECLCALLBACK(void) ConsoleVRDPServer::VRDECallbackInputEvent(void *pvCallback,
2798 uint32_t u32Method,
2799 const void *pvEvent,
2800 uint32_t cbEvent)
2801{
2802 ConsoleVRDPServer *pThis = static_cast<ConsoleVRDPServer*>(pvCallback);
2803
2804 if (u32Method == VRDE_INPUT_METHOD_TOUCH)
2805 {
2806 if (cbEvent >= sizeof(VRDEINPUTHEADER))
2807 {
2808 VRDEINPUTHEADER *pHeader = (VRDEINPUTHEADER *)pvEvent;
2809
2810 if (pHeader->u16EventId == VRDEINPUT_EVENTID_TOUCH)
2811 {
2812 IMouse *pMouse = pThis->mConsole->i_getMouse();
2813
2814 VRDEINPUT_TOUCH_EVENT_PDU *p = (VRDEINPUT_TOUCH_EVENT_PDU *)pHeader;
2815
2816 uint16_t iFrame;
2817 for (iFrame = 0; iFrame < p->u16FrameCount; iFrame++)
2818 {
2819 VRDEINPUT_TOUCH_FRAME *pFrame = &p->aFrames[iFrame];
2820
2821 com::SafeArray<LONG64> aContacts(pFrame->u16ContactCount);
2822
2823 uint16_t iContact;
2824 for (iContact = 0; iContact < pFrame->u16ContactCount; iContact++)
2825 {
2826 VRDEINPUT_CONTACT_DATA *pContact = &pFrame->aContacts[iContact];
2827
2828 int16_t x = (int16_t)(pContact->i32X + 1);
2829 int16_t y = (int16_t)(pContact->i32Y + 1);
2830 uint8_t contactId = pContact->u8ContactId;
2831 uint8_t contactState = TouchContactState_None;
2832
2833 if (pContact->u32ContactFlags & VRDEINPUT_CONTACT_FLAG_INRANGE)
2834 {
2835 contactState |= TouchContactState_InRange;
2836 }
2837 if (pContact->u32ContactFlags & VRDEINPUT_CONTACT_FLAG_INCONTACT)
2838 {
2839 contactState |= TouchContactState_InContact;
2840 }
2841
2842 aContacts[iContact] = RT_MAKE_U64_FROM_U16((uint16_t)x,
2843 (uint16_t)y,
2844 RT_MAKE_U16(contactId, contactState),
2845 0);
2846 }
2847
2848 if (pFrame->u64FrameOffset == 0)
2849 {
2850 pThis->mu64TouchInputTimestampMCS = 0;
2851 }
2852 else
2853 {
2854 pThis->mu64TouchInputTimestampMCS += pFrame->u64FrameOffset;
2855 }
2856
2857 pMouse->PutEventMultiTouch(pFrame->u16ContactCount,
2858 ComSafeArrayAsInParam(aContacts),
2859 (ULONG)(pThis->mu64TouchInputTimestampMCS / 1000)); /* Micro->milliseconds. */
2860 }
2861 }
2862 else if (pHeader->u16EventId == VRDEINPUT_EVENTID_DISMISS_HOVERING_CONTACT)
2863 {
2864 /* @todo */
2865 }
2866 else
2867 {
2868 AssertMsgFailed(("EventId %d\n", pHeader->u16EventId));
2869 }
2870 }
2871 }
2872}
2873
2874
2875void ConsoleVRDPServer::EnableConnections(void)
2876{
2877 if (mpEntryPoints && mhServer)
2878 {
2879 mpEntryPoints->VRDEEnableConnections(mhServer, true);
2880
2881 /* Setup the generic TSMF channel. */
2882 setupTSMF();
2883 }
2884}
2885
2886void ConsoleVRDPServer::DisconnectClient(uint32_t u32ClientId, bool fReconnect)
2887{
2888 if (mpEntryPoints && mhServer)
2889 {
2890 mpEntryPoints->VRDEDisconnect(mhServer, u32ClientId, fReconnect);
2891 }
2892}
2893
2894int ConsoleVRDPServer::MousePointer(BOOL alpha,
2895 ULONG xHot,
2896 ULONG yHot,
2897 ULONG width,
2898 ULONG height,
2899 const uint8_t *pu8Shape)
2900{
2901 int rc = VINF_SUCCESS;
2902
2903 if (mhServer && mpEntryPoints && m_interfaceMousePtr.VRDEMousePtr)
2904 {
2905 size_t cbMask = (((width + 7) / 8) * height + 3) & ~3;
2906 size_t cbData = width * height * 4;
2907
2908 size_t cbDstMask = alpha? 0: cbMask;
2909
2910 size_t cbPointer = sizeof(VRDEMOUSEPTRDATA) + cbDstMask + cbData;
2911 uint8_t *pu8Pointer = (uint8_t *)RTMemAlloc(cbPointer);
2912 if (pu8Pointer != NULL)
2913 {
2914 VRDEMOUSEPTRDATA *pPointer = (VRDEMOUSEPTRDATA *)pu8Pointer;
2915
2916 pPointer->u16HotX = (uint16_t)xHot;
2917 pPointer->u16HotY = (uint16_t)yHot;
2918 pPointer->u16Width = (uint16_t)width;
2919 pPointer->u16Height = (uint16_t)height;
2920 pPointer->u16MaskLen = (uint16_t)cbDstMask;
2921 pPointer->u32DataLen = (uint32_t)cbData;
2922
2923 /* AND mask. */
2924 uint8_t *pu8Mask = pu8Pointer + sizeof(VRDEMOUSEPTRDATA);
2925 if (cbDstMask)
2926 {
2927 memcpy(pu8Mask, pu8Shape, cbDstMask);
2928 }
2929
2930 /* XOR mask */
2931 uint8_t *pu8Data = pu8Mask + pPointer->u16MaskLen;
2932 memcpy(pu8Data, pu8Shape + cbMask, cbData);
2933
2934 m_interfaceMousePtr.VRDEMousePtr(mhServer, pPointer);
2935
2936 RTMemFree(pu8Pointer);
2937 }
2938 else
2939 {
2940 rc = VERR_NO_MEMORY;
2941 }
2942 }
2943 else
2944 {
2945 rc = VERR_NOT_SUPPORTED;
2946 }
2947
2948 return rc;
2949}
2950
2951void ConsoleVRDPServer::MousePointerUpdate(const VRDECOLORPOINTER *pPointer)
2952{
2953 if (mpEntryPoints && mhServer)
2954 {
2955 mpEntryPoints->VRDEColorPointer(mhServer, pPointer);
2956 }
2957}
2958
2959void ConsoleVRDPServer::MousePointerHide(void)
2960{
2961 if (mpEntryPoints && mhServer)
2962 {
2963 mpEntryPoints->VRDEHidePointer(mhServer);
2964 }
2965}
2966
2967void ConsoleVRDPServer::Stop(void)
2968{
2969 Assert(VALID_PTR(this)); /** @todo r=bird: there are(/was) some odd cases where this buster was invalid on
2970 * linux. Just remove this when it's 100% sure that problem has been fixed. */
2971
2972#ifdef VBOX_WITH_USB
2973 remoteUSBThreadStop();
2974#endif /* VBOX_WITH_USB */
2975
2976 if (mhServer)
2977 {
2978 HVRDESERVER hServer = mhServer;
2979
2980 /* Reset the handle to avoid further calls to the server. */
2981 mhServer = 0;
2982
2983 /* Workaround for VM process hangs on termination.
2984 *
2985 * Make sure that the server is not currently processing a resize.
2986 * mhServer 0 will not allow to enter the server again.
2987 * Wait until any current resize returns from the server.
2988 */
2989 if (mcInResize)
2990 {
2991 LogRel(("VRDP: waiting for resize %d\n", mcInResize));
2992
2993 int i = 0;
2994 while (mcInResize && ++i < 100)
2995 {
2996 RTThreadSleep(10);
2997 }
2998 }
2999
3000 if (mpEntryPoints && hServer)
3001 {
3002 mpEntryPoints->VRDEDestroy(hServer);
3003 }
3004 }
3005
3006 mpfnAuthEntry = NULL;
3007 mpfnAuthEntry2 = NULL;
3008 mpfnAuthEntry3 = NULL;
3009
3010 if (mAuthLibrary)
3011 {
3012 RTLdrClose(mAuthLibrary);
3013 mAuthLibrary = 0;
3014 }
3015}
3016
3017/* Worker thread for Remote USB. The thread polls the clients for
3018 * the list of attached USB devices.
3019 * The thread is also responsible for attaching/detaching devices
3020 * to/from the VM.
3021 *
3022 * It is expected that attaching/detaching is not a frequent operation.
3023 *
3024 * The thread is always running when the VRDP server is active.
3025 *
3026 * The thread scans backends and requests the device list every 2 seconds.
3027 *
3028 * When device list is available, the thread calls the Console to process it.
3029 *
3030 */
3031#define VRDP_DEVICE_LIST_PERIOD_MS (2000)
3032
3033#ifdef VBOX_WITH_USB
3034static DECLCALLBACK(int) threadRemoteUSB(RTTHREAD self, void *pvUser)
3035{
3036 ConsoleVRDPServer *pOwner = (ConsoleVRDPServer *)pvUser;
3037
3038 LogFlow(("Console::threadRemoteUSB: start. owner = %p.\n", pOwner));
3039
3040 pOwner->notifyRemoteUSBThreadRunning(self);
3041
3042 while (pOwner->isRemoteUSBThreadRunning())
3043 {
3044 RemoteUSBBackend *pRemoteUSBBackend = NULL;
3045
3046 while ((pRemoteUSBBackend = pOwner->usbBackendGetNext(pRemoteUSBBackend)) != NULL)
3047 {
3048 pRemoteUSBBackend->PollRemoteDevices();
3049 }
3050
3051 pOwner->waitRemoteUSBThreadEvent(VRDP_DEVICE_LIST_PERIOD_MS);
3052
3053 LogFlow(("Console::threadRemoteUSB: iteration. owner = %p.\n", pOwner));
3054 }
3055
3056 return VINF_SUCCESS;
3057}
3058
3059void ConsoleVRDPServer::notifyRemoteUSBThreadRunning(RTTHREAD thread)
3060{
3061 mUSBBackends.thread = thread;
3062 mUSBBackends.fThreadRunning = true;
3063 int rc = RTThreadUserSignal(thread);
3064 AssertRC(rc);
3065}
3066
3067bool ConsoleVRDPServer::isRemoteUSBThreadRunning(void)
3068{
3069 return mUSBBackends.fThreadRunning;
3070}
3071
3072void ConsoleVRDPServer::waitRemoteUSBThreadEvent(RTMSINTERVAL cMillies)
3073{
3074 int rc = RTSemEventWait(mUSBBackends.event, cMillies);
3075 Assert(RT_SUCCESS(rc) || rc == VERR_TIMEOUT);
3076 NOREF(rc);
3077}
3078
3079void ConsoleVRDPServer::remoteUSBThreadStart(void)
3080{
3081 int rc = RTSemEventCreate(&mUSBBackends.event);
3082
3083 if (RT_FAILURE(rc))
3084 {
3085 AssertFailed();
3086 mUSBBackends.event = 0;
3087 }
3088
3089 if (RT_SUCCESS(rc))
3090 {
3091 rc = RTThreadCreate(&mUSBBackends.thread, threadRemoteUSB, this, 65536,
3092 RTTHREADTYPE_VRDP_IO, RTTHREADFLAGS_WAITABLE, "remote usb");
3093 }
3094
3095 if (RT_FAILURE(rc))
3096 {
3097 LogRel(("Warning: could not start the remote USB thread, rc = %Rrc!!!\n", rc));
3098 mUSBBackends.thread = NIL_RTTHREAD;
3099 }
3100 else
3101 {
3102 /* Wait until the thread is ready. */
3103 rc = RTThreadUserWait(mUSBBackends.thread, 60000);
3104 AssertRC(rc);
3105 Assert (mUSBBackends.fThreadRunning || RT_FAILURE(rc));
3106 }
3107}
3108
3109void ConsoleVRDPServer::remoteUSBThreadStop(void)
3110{
3111 mUSBBackends.fThreadRunning = false;
3112
3113 if (mUSBBackends.thread != NIL_RTTHREAD)
3114 {
3115 Assert (mUSBBackends.event != 0);
3116
3117 RTSemEventSignal(mUSBBackends.event);
3118
3119 int rc = RTThreadWait(mUSBBackends.thread, 60000, NULL);
3120 AssertRC(rc);
3121
3122 mUSBBackends.thread = NIL_RTTHREAD;
3123 }
3124
3125 if (mUSBBackends.event)
3126 {
3127 RTSemEventDestroy(mUSBBackends.event);
3128 mUSBBackends.event = 0;
3129 }
3130}
3131#endif /* VBOX_WITH_USB */
3132
3133typedef struct AuthCtx
3134{
3135 AuthResult result;
3136
3137 PAUTHENTRY3 pfnAuthEntry3;
3138 PAUTHENTRY2 pfnAuthEntry2;
3139 PAUTHENTRY pfnAuthEntry;
3140
3141 const char *pszCaller;
3142 PAUTHUUID pUuid;
3143 AuthGuestJudgement guestJudgement;
3144 const char *pszUser;
3145 const char *pszPassword;
3146 const char *pszDomain;
3147 int fLogon;
3148 unsigned clientId;
3149} AuthCtx;
3150
3151static DECLCALLBACK(int) authThread(RTTHREAD self, void *pvUser)
3152{
3153 AuthCtx *pCtx = (AuthCtx *)pvUser;
3154
3155 if (pCtx->pfnAuthEntry3)
3156 {
3157 pCtx->result = pCtx->pfnAuthEntry3(pCtx->pszCaller, pCtx->pUuid, pCtx->guestJudgement,
3158 pCtx->pszUser, pCtx->pszPassword, pCtx->pszDomain,
3159 pCtx->fLogon, pCtx->clientId);
3160 }
3161 else if (pCtx->pfnAuthEntry2)
3162 {
3163 pCtx->result = pCtx->pfnAuthEntry2(pCtx->pUuid, pCtx->guestJudgement,
3164 pCtx->pszUser, pCtx->pszPassword, pCtx->pszDomain,
3165 pCtx->fLogon, pCtx->clientId);
3166 }
3167 else if (pCtx->pfnAuthEntry)
3168 {
3169 pCtx->result = pCtx->pfnAuthEntry(pCtx->pUuid, pCtx->guestJudgement,
3170 pCtx->pszUser, pCtx->pszPassword, pCtx->pszDomain);
3171 }
3172 return VINF_SUCCESS;
3173}
3174
3175static AuthResult authCall(AuthCtx *pCtx)
3176{
3177 AuthResult result = AuthResultAccessDenied;
3178
3179 /* Use a separate thread because external modules might need a lot of stack space. */
3180 RTTHREAD thread = NIL_RTTHREAD;
3181 int rc = RTThreadCreate(&thread, authThread, pCtx, 512*_1K,
3182 RTTHREADTYPE_DEFAULT, RTTHREADFLAGS_WAITABLE, "VRDEAuth");
3183 LogFlow(("authCall: RTThreadCreate %Rrc\n", rc));
3184
3185 if (RT_SUCCESS(rc))
3186 {
3187 rc = RTThreadWait(thread, RT_INDEFINITE_WAIT, NULL);
3188 LogFlow(("authCall: RTThreadWait %Rrc\n", rc));
3189 }
3190
3191 if (RT_SUCCESS(rc))
3192 {
3193 /* Only update the result if the thread finished without errors. */
3194 result = pCtx->result;
3195 }
3196 else
3197 {
3198 LogRel(("AUTH: unable to execute the auth thread %Rrc\n", rc));
3199 }
3200
3201 return result;
3202}
3203
3204AuthResult ConsoleVRDPServer::Authenticate(const Guid &uuid, AuthGuestJudgement guestJudgement,
3205 const char *pszUser, const char *pszPassword, const char *pszDomain,
3206 uint32_t u32ClientId)
3207{
3208 AUTHUUID rawuuid;
3209
3210 memcpy(rawuuid, uuid.raw(), sizeof(rawuuid));
3211
3212 LogFlow(("ConsoleVRDPServer::Authenticate: uuid = %RTuuid, guestJudgement = %d, pszUser = %s, pszPassword = %s, pszDomain = %s, u32ClientId = %d\n",
3213 rawuuid, guestJudgement, pszUser, pszPassword, pszDomain, u32ClientId));
3214
3215 /*
3216 * Called only from VRDP input thread. So thread safety is not required.
3217 */
3218
3219 if (!mAuthLibrary)
3220 {
3221 /* Load the external authentication library. */
3222 Bstr authLibrary;
3223 mConsole->i_getVRDEServer()->COMGETTER(AuthLibrary)(authLibrary.asOutParam());
3224
3225 Utf8Str filename = authLibrary;
3226
3227 LogRel(("AUTH: loading external authentication library '%ls'\n", authLibrary.raw()));
3228
3229 int rc;
3230 if (RTPathHavePath(filename.c_str()))
3231 rc = RTLdrLoad(filename.c_str(), &mAuthLibrary);
3232 else
3233 {
3234 rc = RTLdrLoadAppPriv(filename.c_str(), &mAuthLibrary);
3235 if (RT_FAILURE(rc))
3236 {
3237 /* Backward compatibility with old default 'VRDPAuth' name.
3238 * Try to load new default 'VBoxAuth' instead.
3239 */
3240 if (filename == "VRDPAuth")
3241 {
3242 LogRel(("AUTH: ConsoleVRDPServer::Authenticate: loading external authentication library VBoxAuth\n"));
3243 rc = RTLdrLoadAppPriv("VBoxAuth", &mAuthLibrary);
3244 }
3245 }
3246 }
3247
3248 if (RT_FAILURE(rc))
3249 LogRel(("AUTH: Failed to load external authentication library. Error code: %Rrc\n", rc));
3250
3251 if (RT_SUCCESS(rc))
3252 {
3253 typedef struct AuthEntryInfoStruct
3254 {
3255 const char *pszName;
3256 void **ppvAddress;
3257
3258 } AuthEntryInfo;
3259 AuthEntryInfo entries[] =
3260 {
3261 { AUTHENTRY3_NAME, (void **)&mpfnAuthEntry3 },
3262 { AUTHENTRY2_NAME, (void **)&mpfnAuthEntry2 },
3263 { AUTHENTRY_NAME, (void **)&mpfnAuthEntry },
3264 { NULL, NULL }
3265 };
3266
3267 /* Get the entry point. */
3268 AuthEntryInfo *pEntryInfo = &entries[0];
3269 while (pEntryInfo->pszName)
3270 {
3271 *pEntryInfo->ppvAddress = NULL;
3272
3273 int rc2 = RTLdrGetSymbol(mAuthLibrary, pEntryInfo->pszName, pEntryInfo->ppvAddress);
3274 if (RT_SUCCESS(rc2))
3275 {
3276 /* Found an entry point. */
3277 LogRel(("AUTH: Using entry point '%s'.\n", pEntryInfo->pszName));
3278 rc = VINF_SUCCESS;
3279 break;
3280 }
3281
3282 if (rc2 != VERR_SYMBOL_NOT_FOUND)
3283 {
3284 LogRel(("AUTH: Could not resolve import '%s'. Error code: %Rrc\n", pEntryInfo->pszName, rc2));
3285 }
3286 rc = rc2;
3287
3288 pEntryInfo++;
3289 }
3290 }
3291
3292 if (RT_FAILURE(rc))
3293 {
3294 mConsole->setError(E_FAIL,
3295 mConsole->tr("Could not load the external authentication library '%s' (%Rrc)"),
3296 filename.c_str(),
3297 rc);
3298
3299 mpfnAuthEntry = NULL;
3300 mpfnAuthEntry2 = NULL;
3301 mpfnAuthEntry3 = NULL;
3302
3303 if (mAuthLibrary)
3304 {
3305 RTLdrClose(mAuthLibrary);
3306 mAuthLibrary = 0;
3307 }
3308
3309 return AuthResultAccessDenied;
3310 }
3311 }
3312
3313 Assert(mAuthLibrary && (mpfnAuthEntry || mpfnAuthEntry2 || mpfnAuthEntry3));
3314
3315 AuthCtx ctx;
3316 ctx.result = AuthResultAccessDenied; /* Denied by default. */
3317 ctx.pfnAuthEntry3 = mpfnAuthEntry3;
3318 ctx.pfnAuthEntry2 = mpfnAuthEntry2;
3319 ctx.pfnAuthEntry = mpfnAuthEntry;
3320 ctx.pszCaller = "vrde";
3321 ctx.pUuid = &rawuuid;
3322 ctx.guestJudgement = guestJudgement;
3323 ctx.pszUser = pszUser;
3324 ctx.pszPassword = pszPassword;
3325 ctx.pszDomain = pszDomain;
3326 ctx.fLogon = true;
3327 ctx.clientId = u32ClientId;
3328
3329 AuthResult result = authCall(&ctx);
3330
3331 switch (result)
3332 {
3333 case AuthResultAccessDenied:
3334 LogRel(("AUTH: external authentication module returned 'access denied'\n"));
3335 break;
3336 case AuthResultAccessGranted:
3337 LogRel(("AUTH: external authentication module returned 'access granted'\n"));
3338 break;
3339 case AuthResultDelegateToGuest:
3340 LogRel(("AUTH: external authentication module returned 'delegate request to guest'\n"));
3341 break;
3342 default:
3343 LogRel(("AUTH: external authentication module returned incorrect return code %d\n", result));
3344 result = AuthResultAccessDenied;
3345 }
3346
3347 LogFlow(("ConsoleVRDPServer::Authenticate: result = %d\n", result));
3348
3349 return result;
3350}
3351
3352void ConsoleVRDPServer::AuthDisconnect(const Guid &uuid, uint32_t u32ClientId)
3353{
3354 AUTHUUID rawuuid;
3355
3356 memcpy(rawuuid, uuid.raw(), sizeof(rawuuid));
3357
3358 LogFlow(("ConsoleVRDPServer::AuthDisconnect: uuid = %RTuuid, u32ClientId = %d\n",
3359 rawuuid, u32ClientId));
3360
3361 Assert(mAuthLibrary && (mpfnAuthEntry || mpfnAuthEntry2 || mpfnAuthEntry3));
3362
3363 AuthCtx ctx;
3364 ctx.result = AuthResultAccessDenied; /* Not used. */
3365 ctx.pfnAuthEntry3 = mpfnAuthEntry3;
3366 ctx.pfnAuthEntry2 = mpfnAuthEntry2;
3367 ctx.pfnAuthEntry = NULL; /* Does not use disconnect notification. */
3368 ctx.pszCaller = "vrde";
3369 ctx.pUuid = &rawuuid;
3370 ctx.guestJudgement = AuthGuestNotAsked;
3371 ctx.pszUser = NULL;
3372 ctx.pszPassword = NULL;
3373 ctx.pszDomain = NULL;
3374 ctx.fLogon = false;
3375 ctx.clientId = u32ClientId;
3376
3377 authCall(&ctx);
3378}
3379
3380int ConsoleVRDPServer::lockConsoleVRDPServer(void)
3381{
3382 int rc = RTCritSectEnter(&mCritSect);
3383 AssertRC(rc);
3384 return rc;
3385}
3386
3387void ConsoleVRDPServer::unlockConsoleVRDPServer(void)
3388{
3389 RTCritSectLeave(&mCritSect);
3390}
3391
3392DECLCALLBACK(int) ConsoleVRDPServer::ClipboardCallback(void *pvCallback,
3393 uint32_t u32ClientId,
3394 uint32_t u32Function,
3395 uint32_t u32Format,
3396 const void *pvData,
3397 uint32_t cbData)
3398{
3399 LogFlowFunc(("pvCallback = %p, u32ClientId = %d, u32Function = %d, u32Format = 0x%08X, pvData = %p, cbData = %d\n",
3400 pvCallback, u32ClientId, u32Function, u32Format, pvData, cbData));
3401
3402 int rc = VINF_SUCCESS;
3403
3404 ConsoleVRDPServer *pServer = static_cast <ConsoleVRDPServer *>(pvCallback);
3405
3406 NOREF(u32ClientId);
3407
3408 switch (u32Function)
3409 {
3410 case VRDE_CLIPBOARD_FUNCTION_FORMAT_ANNOUNCE:
3411 {
3412 if (pServer->mpfnClipboardCallback)
3413 {
3414 pServer->mpfnClipboardCallback(VBOX_CLIPBOARD_EXT_FN_FORMAT_ANNOUNCE,
3415 u32Format,
3416 (void *)pvData,
3417 cbData);
3418 }
3419 } break;
3420
3421 case VRDE_CLIPBOARD_FUNCTION_DATA_READ:
3422 {
3423 if (pServer->mpfnClipboardCallback)
3424 {
3425 pServer->mpfnClipboardCallback(VBOX_CLIPBOARD_EXT_FN_DATA_READ,
3426 u32Format,
3427 (void *)pvData,
3428 cbData);
3429 }
3430 } break;
3431
3432 default:
3433 rc = VERR_NOT_SUPPORTED;
3434 }
3435
3436 return rc;
3437}
3438
3439DECLCALLBACK(int) ConsoleVRDPServer::ClipboardServiceExtension(void *pvExtension,
3440 uint32_t u32Function,
3441 void *pvParms,
3442 uint32_t cbParms)
3443{
3444 LogFlowFunc(("pvExtension = %p, u32Function = %d, pvParms = %p, cbParms = %d\n",
3445 pvExtension, u32Function, pvParms, cbParms));
3446
3447 int rc = VINF_SUCCESS;
3448
3449 ConsoleVRDPServer *pServer = static_cast <ConsoleVRDPServer *>(pvExtension);
3450
3451 VBOXCLIPBOARDEXTPARMS *pParms = (VBOXCLIPBOARDEXTPARMS *)pvParms;
3452
3453 switch (u32Function)
3454 {
3455 case VBOX_CLIPBOARD_EXT_FN_SET_CALLBACK:
3456 {
3457 pServer->mpfnClipboardCallback = pParms->u.pfnCallback;
3458 } break;
3459
3460 case VBOX_CLIPBOARD_EXT_FN_FORMAT_ANNOUNCE:
3461 {
3462 /* The guest announces clipboard formats. This must be delivered to all clients. */
3463 if (mpEntryPoints && pServer->mhServer)
3464 {
3465 mpEntryPoints->VRDEClipboard(pServer->mhServer,
3466 VRDE_CLIPBOARD_FUNCTION_FORMAT_ANNOUNCE,
3467 pParms->u32Format,
3468 NULL,
3469 0,
3470 NULL);
3471 }
3472 } break;
3473
3474 case VBOX_CLIPBOARD_EXT_FN_DATA_READ:
3475 {
3476 /* The clipboard service expects that the pvData buffer will be filled
3477 * with clipboard data. The server returns the data from the client that
3478 * announced the requested format most recently.
3479 */
3480 if (mpEntryPoints && pServer->mhServer)
3481 {
3482 mpEntryPoints->VRDEClipboard(pServer->mhServer,
3483 VRDE_CLIPBOARD_FUNCTION_DATA_READ,
3484 pParms->u32Format,
3485 pParms->u.pvData,
3486 pParms->cbData,
3487 &pParms->cbData);
3488 }
3489 } break;
3490
3491 case VBOX_CLIPBOARD_EXT_FN_DATA_WRITE:
3492 {
3493 if (mpEntryPoints && pServer->mhServer)
3494 {
3495 mpEntryPoints->VRDEClipboard(pServer->mhServer,
3496 VRDE_CLIPBOARD_FUNCTION_DATA_WRITE,
3497 pParms->u32Format,
3498 pParms->u.pvData,
3499 pParms->cbData,
3500 NULL);
3501 }
3502 } break;
3503
3504 default:
3505 rc = VERR_NOT_SUPPORTED;
3506 }
3507
3508 return rc;
3509}
3510
3511void ConsoleVRDPServer::ClipboardCreate(uint32_t u32ClientId)
3512{
3513 int rc = lockConsoleVRDPServer();
3514
3515 if (RT_SUCCESS(rc))
3516 {
3517 if (mcClipboardRefs == 0)
3518 {
3519 rc = HGCMHostRegisterServiceExtension(&mhClipboard, "VBoxSharedClipboard", ClipboardServiceExtension, this);
3520
3521 if (RT_SUCCESS(rc))
3522 {
3523 mcClipboardRefs++;
3524 }
3525 }
3526
3527 unlockConsoleVRDPServer();
3528 }
3529}
3530
3531void ConsoleVRDPServer::ClipboardDelete(uint32_t u32ClientId)
3532{
3533 int rc = lockConsoleVRDPServer();
3534
3535 if (RT_SUCCESS(rc))
3536 {
3537 mcClipboardRefs--;
3538
3539 if (mcClipboardRefs == 0)
3540 {
3541 HGCMHostUnregisterServiceExtension(mhClipboard);
3542 }
3543
3544 unlockConsoleVRDPServer();
3545 }
3546}
3547
3548/* That is called on INPUT thread of the VRDP server.
3549 * The ConsoleVRDPServer keeps a list of created backend instances.
3550 */
3551void ConsoleVRDPServer::USBBackendCreate(uint32_t u32ClientId, void **ppvIntercept)
3552{
3553#ifdef VBOX_WITH_USB
3554 LogFlow(("ConsoleVRDPServer::USBBackendCreate: u32ClientId = %d\n", u32ClientId));
3555
3556 /* Create a new instance of the USB backend for the new client. */
3557 RemoteUSBBackend *pRemoteUSBBackend = new RemoteUSBBackend(mConsole, this, u32ClientId);
3558
3559 if (pRemoteUSBBackend)
3560 {
3561 pRemoteUSBBackend->AddRef(); /* 'Release' called in USBBackendDelete. */
3562
3563 /* Append the new instance in the list. */
3564 int rc = lockConsoleVRDPServer();
3565
3566 if (RT_SUCCESS(rc))
3567 {
3568 pRemoteUSBBackend->pNext = mUSBBackends.pHead;
3569 if (mUSBBackends.pHead)
3570 {
3571 mUSBBackends.pHead->pPrev = pRemoteUSBBackend;
3572 }
3573 else
3574 {
3575 mUSBBackends.pTail = pRemoteUSBBackend;
3576 }
3577
3578 mUSBBackends.pHead = pRemoteUSBBackend;
3579
3580 unlockConsoleVRDPServer();
3581
3582 if (ppvIntercept)
3583 {
3584 *ppvIntercept = pRemoteUSBBackend;
3585 }
3586 }
3587
3588 if (RT_FAILURE(rc))
3589 {
3590 pRemoteUSBBackend->Release();
3591 }
3592 }
3593#endif /* VBOX_WITH_USB */
3594}
3595
3596void ConsoleVRDPServer::USBBackendDelete(uint32_t u32ClientId)
3597{
3598#ifdef VBOX_WITH_USB
3599 LogFlow(("ConsoleVRDPServer::USBBackendDelete: u32ClientId = %d\n", u32ClientId));
3600
3601 RemoteUSBBackend *pRemoteUSBBackend = NULL;
3602
3603 /* Find the instance. */
3604 int rc = lockConsoleVRDPServer();
3605
3606 if (RT_SUCCESS(rc))
3607 {
3608 pRemoteUSBBackend = usbBackendFind(u32ClientId);
3609
3610 if (pRemoteUSBBackend)
3611 {
3612 /* Notify that it will be deleted. */
3613 pRemoteUSBBackend->NotifyDelete();
3614 }
3615
3616 unlockConsoleVRDPServer();
3617 }
3618
3619 if (pRemoteUSBBackend)
3620 {
3621 /* Here the instance has been excluded from the list and can be dereferenced. */
3622 pRemoteUSBBackend->Release();
3623 }
3624#endif
3625}
3626
3627void *ConsoleVRDPServer::USBBackendRequestPointer(uint32_t u32ClientId, const Guid *pGuid)
3628{
3629#ifdef VBOX_WITH_USB
3630 RemoteUSBBackend *pRemoteUSBBackend = NULL;
3631
3632 /* Find the instance. */
3633 int rc = lockConsoleVRDPServer();
3634
3635 if (RT_SUCCESS(rc))
3636 {
3637 pRemoteUSBBackend = usbBackendFind(u32ClientId);
3638
3639 if (pRemoteUSBBackend)
3640 {
3641 /* Inform the backend instance that it is referenced by the Guid. */
3642 bool fAdded = pRemoteUSBBackend->addUUID(pGuid);
3643
3644 if (fAdded)
3645 {
3646 /* Reference the instance because its pointer is being taken. */
3647 pRemoteUSBBackend->AddRef(); /* 'Release' is called in USBBackendReleasePointer. */
3648 }
3649 else
3650 {
3651 pRemoteUSBBackend = NULL;
3652 }
3653 }
3654
3655 unlockConsoleVRDPServer();
3656 }
3657
3658 if (pRemoteUSBBackend)
3659 {
3660 return pRemoteUSBBackend->GetBackendCallbackPointer();
3661 }
3662
3663#endif
3664 return NULL;
3665}
3666
3667void ConsoleVRDPServer::USBBackendReleasePointer(const Guid *pGuid)
3668{
3669#ifdef VBOX_WITH_USB
3670 RemoteUSBBackend *pRemoteUSBBackend = NULL;
3671
3672 /* Find the instance. */
3673 int rc = lockConsoleVRDPServer();
3674
3675 if (RT_SUCCESS(rc))
3676 {
3677 pRemoteUSBBackend = usbBackendFindByUUID(pGuid);
3678
3679 if (pRemoteUSBBackend)
3680 {
3681 pRemoteUSBBackend->removeUUID(pGuid);
3682 }
3683
3684 unlockConsoleVRDPServer();
3685
3686 if (pRemoteUSBBackend)
3687 {
3688 pRemoteUSBBackend->Release();
3689 }
3690 }
3691#endif
3692}
3693
3694RemoteUSBBackend *ConsoleVRDPServer::usbBackendGetNext(RemoteUSBBackend *pRemoteUSBBackend)
3695{
3696 LogFlow(("ConsoleVRDPServer::usbBackendGetNext: pBackend = %p\n", pRemoteUSBBackend));
3697
3698 RemoteUSBBackend *pNextRemoteUSBBackend = NULL;
3699#ifdef VBOX_WITH_USB
3700
3701 int rc = lockConsoleVRDPServer();
3702
3703 if (RT_SUCCESS(rc))
3704 {
3705 if (pRemoteUSBBackend == NULL)
3706 {
3707 /* The first backend in the list is requested. */
3708 pNextRemoteUSBBackend = mUSBBackends.pHead;
3709 }
3710 else
3711 {
3712 /* Get pointer to the next backend. */
3713 pNextRemoteUSBBackend = (RemoteUSBBackend *)pRemoteUSBBackend->pNext;
3714 }
3715
3716 if (pNextRemoteUSBBackend)
3717 {
3718 pNextRemoteUSBBackend->AddRef();
3719 }
3720
3721 unlockConsoleVRDPServer();
3722
3723 if (pRemoteUSBBackend)
3724 {
3725 pRemoteUSBBackend->Release();
3726 }
3727 }
3728#endif
3729
3730 return pNextRemoteUSBBackend;
3731}
3732
3733#ifdef VBOX_WITH_USB
3734/* Internal method. Called under the ConsoleVRDPServerLock. */
3735RemoteUSBBackend *ConsoleVRDPServer::usbBackendFind(uint32_t u32ClientId)
3736{
3737 RemoteUSBBackend *pRemoteUSBBackend = mUSBBackends.pHead;
3738
3739 while (pRemoteUSBBackend)
3740 {
3741 if (pRemoteUSBBackend->ClientId() == u32ClientId)
3742 {
3743 break;
3744 }
3745
3746 pRemoteUSBBackend = (RemoteUSBBackend *)pRemoteUSBBackend->pNext;
3747 }
3748
3749 return pRemoteUSBBackend;
3750}
3751
3752/* Internal method. Called under the ConsoleVRDPServerLock. */
3753RemoteUSBBackend *ConsoleVRDPServer::usbBackendFindByUUID(const Guid *pGuid)
3754{
3755 RemoteUSBBackend *pRemoteUSBBackend = mUSBBackends.pHead;
3756
3757 while (pRemoteUSBBackend)
3758 {
3759 if (pRemoteUSBBackend->findUUID(pGuid))
3760 {
3761 break;
3762 }
3763
3764 pRemoteUSBBackend = (RemoteUSBBackend *)pRemoteUSBBackend->pNext;
3765 }
3766
3767 return pRemoteUSBBackend;
3768}
3769#endif
3770
3771/* Internal method. Called by the backend destructor. */
3772void ConsoleVRDPServer::usbBackendRemoveFromList(RemoteUSBBackend *pRemoteUSBBackend)
3773{
3774#ifdef VBOX_WITH_USB
3775 int rc = lockConsoleVRDPServer();
3776 AssertRC(rc);
3777
3778 /* Exclude the found instance from the list. */
3779 if (pRemoteUSBBackend->pNext)
3780 {
3781 pRemoteUSBBackend->pNext->pPrev = pRemoteUSBBackend->pPrev;
3782 }
3783 else
3784 {
3785 mUSBBackends.pTail = (RemoteUSBBackend *)pRemoteUSBBackend->pPrev;
3786 }
3787
3788 if (pRemoteUSBBackend->pPrev)
3789 {
3790 pRemoteUSBBackend->pPrev->pNext = pRemoteUSBBackend->pNext;
3791 }
3792 else
3793 {
3794 mUSBBackends.pHead = (RemoteUSBBackend *)pRemoteUSBBackend->pNext;
3795 }
3796
3797 pRemoteUSBBackend->pNext = pRemoteUSBBackend->pPrev = NULL;
3798
3799 unlockConsoleVRDPServer();
3800#endif
3801}
3802
3803
3804void ConsoleVRDPServer::SendUpdate(unsigned uScreenId, void *pvUpdate, uint32_t cbUpdate) const
3805{
3806 if (mpEntryPoints && mhServer)
3807 {
3808 mpEntryPoints->VRDEUpdate(mhServer, uScreenId, pvUpdate, cbUpdate);
3809 }
3810}
3811
3812void ConsoleVRDPServer::SendResize(void)
3813{
3814 if (mpEntryPoints && mhServer)
3815 {
3816 ++mcInResize;
3817 mpEntryPoints->VRDEResize(mhServer);
3818 --mcInResize;
3819 }
3820}
3821
3822void ConsoleVRDPServer::SendUpdateBitmap(unsigned uScreenId, uint32_t x, uint32_t y, uint32_t w, uint32_t h) const
3823{
3824 VRDEORDERHDR update;
3825 update.x = x;
3826 update.y = y;
3827 update.w = w;
3828 update.h = h;
3829 if (mpEntryPoints && mhServer)
3830 {
3831 mpEntryPoints->VRDEUpdate(mhServer, uScreenId, &update, sizeof(update));
3832 }
3833}
3834
3835void ConsoleVRDPServer::SendAudioSamples(void *pvSamples, uint32_t cSamples, VRDEAUDIOFORMAT format) const
3836{
3837 if (mpEntryPoints && mhServer)
3838 {
3839 mpEntryPoints->VRDEAudioSamples(mhServer, pvSamples, cSamples, format);
3840 }
3841}
3842
3843void ConsoleVRDPServer::SendAudioVolume(uint16_t left, uint16_t right) const
3844{
3845 if (mpEntryPoints && mhServer)
3846 {
3847 mpEntryPoints->VRDEAudioVolume(mhServer, left, right);
3848 }
3849}
3850
3851void ConsoleVRDPServer::SendUSBRequest(uint32_t u32ClientId, void *pvParms, uint32_t cbParms) const
3852{
3853 if (mpEntryPoints && mhServer)
3854 {
3855 mpEntryPoints->VRDEUSBRequest(mhServer, u32ClientId, pvParms, cbParms);
3856 }
3857}
3858
3859int ConsoleVRDPServer::SendAudioInputBegin(void **ppvUserCtx,
3860 void *pvContext,
3861 uint32_t cSamples,
3862 uint32_t iSampleHz,
3863 uint32_t cChannels,
3864 uint32_t cBits)
3865{
3866 if ( mhServer
3867 && mpEntryPoints && mpEntryPoints->VRDEAudioInOpen)
3868 {
3869 uint32_t u32ClientId = ASMAtomicReadU32(&mu32AudioInputClientId);
3870 if (u32ClientId != 0) /* 0 would mean broadcast to all clients. */
3871 {
3872 VRDEAUDIOFORMAT audioFormat = VRDE_AUDIO_FMT_MAKE(iSampleHz, cChannels, cBits, 0);
3873 mpEntryPoints->VRDEAudioInOpen(mhServer,
3874 pvContext,
3875 u32ClientId,
3876 audioFormat,
3877 cSamples);
3878 if (ppvUserCtx)
3879 *ppvUserCtx = NULL; /* This is the ConsoleVRDPServer context.
3880 * Currently not used because only one client is allowed to
3881 * do audio input and the client ID is saved by the ConsoleVRDPServer.
3882 */
3883 return VINF_SUCCESS;
3884 }
3885 }
3886
3887 /*
3888 * Not supported or no client connected.
3889 */
3890 return VERR_NOT_SUPPORTED;
3891}
3892
3893void ConsoleVRDPServer::SendAudioInputEnd(void *pvUserCtx)
3894{
3895 if (mpEntryPoints && mhServer && mpEntryPoints->VRDEAudioInClose)
3896 {
3897 uint32_t u32ClientId = ASMAtomicReadU32(&mu32AudioInputClientId);
3898 if (u32ClientId != 0) /* 0 would mean broadcast to all clients. */
3899 {
3900 mpEntryPoints->VRDEAudioInClose(mhServer, u32ClientId);
3901 }
3902 }
3903}
3904
3905void ConsoleVRDPServer::QueryInfo(uint32_t index, void *pvBuffer, uint32_t cbBuffer, uint32_t *pcbOut) const
3906{
3907 if (index == VRDE_QI_PORT)
3908 {
3909 uint32_t cbOut = sizeof(int32_t);
3910
3911 if (cbBuffer >= cbOut)
3912 {
3913 *pcbOut = cbOut;
3914 *(int32_t *)pvBuffer = (int32_t)mVRDPBindPort;
3915 }
3916 }
3917 else if (mpEntryPoints && mhServer)
3918 {
3919 mpEntryPoints->VRDEQueryInfo(mhServer, index, pvBuffer, cbBuffer, pcbOut);
3920 }
3921}
3922
3923/* static */ int ConsoleVRDPServer::loadVRDPLibrary(const char *pszLibraryName)
3924{
3925 int rc = VINF_SUCCESS;
3926
3927 if (mVRDPLibrary == NIL_RTLDRMOD)
3928 {
3929 RTERRINFOSTATIC ErrInfo;
3930 RTErrInfoInitStatic(&ErrInfo);
3931
3932 if (RTPathHavePath(pszLibraryName))
3933 rc = SUPR3HardenedLdrLoadPlugIn(pszLibraryName, &mVRDPLibrary, &ErrInfo.Core);
3934 else
3935 rc = SUPR3HardenedLdrLoadAppPriv(pszLibraryName, &mVRDPLibrary, RTLDRLOAD_FLAGS_LOCAL, &ErrInfo.Core);
3936 if (RT_SUCCESS(rc))
3937 {
3938 struct SymbolEntry
3939 {
3940 const char *name;
3941 void **ppfn;
3942 };
3943
3944 #define DEFSYMENTRY(a) { #a, (void**)&mpfn##a }
3945
3946 static const struct SymbolEntry s_aSymbols[] =
3947 {
3948 DEFSYMENTRY(VRDECreateServer)
3949 };
3950
3951 #undef DEFSYMENTRY
3952
3953 for (unsigned i = 0; i < RT_ELEMENTS(s_aSymbols); i++)
3954 {
3955 rc = RTLdrGetSymbol(mVRDPLibrary, s_aSymbols[i].name, s_aSymbols[i].ppfn);
3956
3957 if (RT_FAILURE(rc))
3958 {
3959 LogRel(("VRDE: Error resolving symbol '%s', rc %Rrc.\n", s_aSymbols[i].name, rc));
3960 break;
3961 }
3962 }
3963 }
3964 else
3965 {
3966 if (RTErrInfoIsSet(&ErrInfo.Core))
3967 LogRel(("VRDE: Error loading the library '%s': %s (%Rrc)\n", pszLibraryName, ErrInfo.Core.pszMsg, rc));
3968 else
3969 LogRel(("VRDE: Error loading the library '%s' rc = %Rrc.\n", pszLibraryName, rc));
3970
3971 mVRDPLibrary = NIL_RTLDRMOD;
3972 }
3973 }
3974
3975 if (RT_FAILURE(rc))
3976 {
3977 if (mVRDPLibrary != NIL_RTLDRMOD)
3978 {
3979 RTLdrClose(mVRDPLibrary);
3980 mVRDPLibrary = NIL_RTLDRMOD;
3981 }
3982 }
3983
3984 return rc;
3985}
3986
3987/*
3988 * IVRDEServerInfo implementation.
3989 */
3990// constructor / destructor
3991/////////////////////////////////////////////////////////////////////////////
3992
3993VRDEServerInfo::VRDEServerInfo()
3994 : mParent(NULL)
3995{
3996}
3997
3998VRDEServerInfo::~VRDEServerInfo()
3999{
4000}
4001
4002
4003HRESULT VRDEServerInfo::FinalConstruct()
4004{
4005 return BaseFinalConstruct();
4006}
4007
4008void VRDEServerInfo::FinalRelease()
4009{
4010 uninit();
4011 BaseFinalRelease();
4012}
4013
4014// public methods only for internal purposes
4015/////////////////////////////////////////////////////////////////////////////
4016
4017/**
4018 * Initializes the guest object.
4019 */
4020HRESULT VRDEServerInfo::init(Console *aParent)
4021{
4022 LogFlowThisFunc(("aParent=%p\n", aParent));
4023
4024 ComAssertRet(aParent, E_INVALIDARG);
4025
4026 /* Enclose the state transition NotReady->InInit->Ready */
4027 AutoInitSpan autoInitSpan(this);
4028 AssertReturn(autoInitSpan.isOk(), E_FAIL);
4029
4030 unconst(mParent) = aParent;
4031
4032 /* Confirm a successful initialization */
4033 autoInitSpan.setSucceeded();
4034
4035 return S_OK;
4036}
4037
4038/**
4039 * Uninitializes the instance and sets the ready flag to FALSE.
4040 * Called either from FinalRelease() or by the parent when it gets destroyed.
4041 */
4042void VRDEServerInfo::uninit()
4043{
4044 LogFlowThisFunc(("\n"));
4045
4046 /* Enclose the state transition Ready->InUninit->NotReady */
4047 AutoUninitSpan autoUninitSpan(this);
4048 if (autoUninitSpan.uninitDone())
4049 return;
4050
4051 unconst(mParent) = NULL;
4052}
4053
4054// IVRDEServerInfo properties
4055/////////////////////////////////////////////////////////////////////////////
4056
4057#define IMPL_GETTER_BOOL(_aType, _aName, _aIndex) \
4058 HRESULT VRDEServerInfo::get##_aName(_aType *a##_aName) \
4059 { \
4060 /* todo: Not sure if a AutoReadLock would be sufficient. */ \
4061 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS); \
4062 \
4063 uint32_t value; \
4064 uint32_t cbOut = 0; \
4065 \
4066 mParent->i_consoleVRDPServer()->QueryInfo \
4067 (_aIndex, &value, sizeof(value), &cbOut); \
4068 \
4069 *a##_aName = cbOut? !!value: FALSE; \
4070 \
4071 return S_OK; \
4072 } \
4073 extern void IMPL_GETTER_BOOL_DUMMY(void)
4074
4075#define IMPL_GETTER_SCALAR(_aType, _aName, _aIndex, _aValueMask) \
4076 HRESULT VRDEServerInfo::get##_aName(_aType *a##_aName) \
4077 { \
4078 /* todo: Not sure if a AutoReadLock would be sufficient. */ \
4079 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS); \
4080 \
4081 _aType value; \
4082 uint32_t cbOut = 0; \
4083 \
4084 mParent->i_consoleVRDPServer()->QueryInfo \
4085 (_aIndex, &value, sizeof(value), &cbOut); \
4086 \
4087 if (_aValueMask) value &= (_aValueMask); \
4088 *a##_aName = cbOut? value: 0; \
4089 \
4090 return S_OK; \
4091 } \
4092 extern void IMPL_GETTER_SCALAR_DUMMY(void)
4093
4094#define IMPL_GETTER_UTF8STR(_aType, _aName, _aIndex) \
4095 HRESULT VRDEServerInfo::get##_aName(_aType &a##_aName) \
4096 { \
4097 /* todo: Not sure if a AutoReadLock would be sufficient. */ \
4098 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS); \
4099 \
4100 uint32_t cbOut = 0; \
4101 \
4102 mParent->i_consoleVRDPServer()->QueryInfo \
4103 (_aIndex, NULL, 0, &cbOut); \
4104 \
4105 if (cbOut == 0) \
4106 { \
4107 a##_aName = Utf8Str::Empty; \
4108 return S_OK; \
4109 } \
4110 \
4111 char *pchBuffer = (char *)RTMemTmpAlloc(cbOut); \
4112 \
4113 if (!pchBuffer) \
4114 { \
4115 Log(("VRDEServerInfo::" \
4116 #_aName \
4117 ": Failed to allocate memory %d bytes\n", cbOut)); \
4118 return E_OUTOFMEMORY; \
4119 } \
4120 \
4121 mParent->i_consoleVRDPServer()->QueryInfo \
4122 (_aIndex, pchBuffer, cbOut, &cbOut); \
4123 \
4124 a##_aName = pchBuffer; \
4125 \
4126 RTMemTmpFree(pchBuffer); \
4127 \
4128 return S_OK; \
4129 } \
4130 extern void IMPL_GETTER_BSTR_DUMMY(void)
4131
4132IMPL_GETTER_BOOL (BOOL, Active, VRDE_QI_ACTIVE);
4133IMPL_GETTER_SCALAR (LONG, Port, VRDE_QI_PORT, 0);
4134IMPL_GETTER_SCALAR (ULONG, NumberOfClients, VRDE_QI_NUMBER_OF_CLIENTS, 0);
4135IMPL_GETTER_SCALAR (LONG64, BeginTime, VRDE_QI_BEGIN_TIME, 0);
4136IMPL_GETTER_SCALAR (LONG64, EndTime, VRDE_QI_END_TIME, 0);
4137IMPL_GETTER_SCALAR (LONG64, BytesSent, VRDE_QI_BYTES_SENT, INT64_MAX);
4138IMPL_GETTER_SCALAR (LONG64, BytesSentTotal, VRDE_QI_BYTES_SENT_TOTAL, INT64_MAX);
4139IMPL_GETTER_SCALAR (LONG64, BytesReceived, VRDE_QI_BYTES_RECEIVED, INT64_MAX);
4140IMPL_GETTER_SCALAR (LONG64, BytesReceivedTotal, VRDE_QI_BYTES_RECEIVED_TOTAL, INT64_MAX);
4141IMPL_GETTER_UTF8STR(Utf8Str, User, VRDE_QI_USER);
4142IMPL_GETTER_UTF8STR(Utf8Str, Domain, VRDE_QI_DOMAIN);
4143IMPL_GETTER_UTF8STR(Utf8Str, ClientName, VRDE_QI_CLIENT_NAME);
4144IMPL_GETTER_UTF8STR(Utf8Str, ClientIP, VRDE_QI_CLIENT_IP);
4145IMPL_GETTER_SCALAR (ULONG, ClientVersion, VRDE_QI_CLIENT_VERSION, 0);
4146IMPL_GETTER_SCALAR (ULONG, EncryptionStyle, VRDE_QI_ENCRYPTION_STYLE, 0);
4147
4148#undef IMPL_GETTER_UTF8STR
4149#undef IMPL_GETTER_SCALAR
4150#undef IMPL_GETTER_BOOL
4151/* vi: set tabstop=4 shiftwidth=4 expandtab: */
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette