VirtualBox

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

最後變更 在這個檔案從51092是 51092,由 vboxsync 提交於 11 年 前

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

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