VirtualBox

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

Last change on this file since 47469 was 47464, checked in by vboxsync, 11 years ago

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

© 2023 Oracle
Contact – Privacy policy – Terms of Use