-
Notifications
You must be signed in to change notification settings - Fork 157
Expand file tree
/
Copy pathVMMDev.cpp
More file actions
5467 lines (4711 loc) · 222 KB
/
VMMDev.cpp
File metadata and controls
5467 lines (4711 loc) · 222 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* $Id: VMMDev.cpp 113153 2026-02-24 23:06:29Z vitali.pelenjow@oracle.com $ */
/** @file
* VMMDev - Guest <-> VMM/Host communication device.
*/
/*
* Copyright (C) 2006-2026 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* SPDX-License-Identifier: GPL-3.0-only
*/
/** @page pg_vmmdev The VMM Device.
*
* The VMM device is a custom hardware device emulation for communicating with
* the guest additions.
*
* Whenever host wants to inform guest about something an IRQ notification will
* be raised.
*
* VMMDev PDM interface will contain the guest notification method.
*
* There is a 32 bit event mask which will be read by guest on an interrupt. A
* non zero bit in the mask means that the specific event occurred and requires
* processing on guest side.
*
* After reading the event mask guest must issue a generic request
* AcknowlegdeEvents.
*
* IRQ line is set to 1 (request) if there are unprocessed events, that is the
* event mask is not zero.
*
* After receiving an interrupt and checking event mask, the guest must process
* events using the event specific mechanism.
*
* That is if mouse capabilities were changed, guest will use
* VMMDev_GetMouseStatus generic request.
*
* Event mask is only a set of flags indicating that guest must proceed with a
* procedure.
*
* Unsupported events are therefore ignored. The guest additions must inform
* host which events they want to receive, to avoid unnecessary IRQ processing.
* By default no events are signalled to guest.
*
* This seems to be fast method. It requires only one context switch for an
* event processing.
*
*
* @section sec_vmmdev_heartbeat Heartbeat
*
* The heartbeat is a feature to monitor whether the guest OS is hung or not.
*
* The main kernel component of the guest additions, VBoxGuest, sets up a timer
* at a frequency returned by VMMDevReq_HeartbeatConfigure
* (VMMDevReqHeartbeat::cNsInterval, VMMDEV::cNsHeartbeatInterval) and performs
* a VMMDevReq_GuestHeartbeat request every time the timer ticks.
*
* The host side (VMMDev) arms a timer with a more distant deadline
* (VMMDEV::cNsHeartbeatTimeout), twice cNsHeartbeatInterval by default. Each
* time a VMMDevReq_GuestHeartbeat request comes in, the timer is rearmed with
* the same relative deadline. So, as long as VMMDevReq_GuestHeartbeat comes
* when they should, the host timer will never fire.
*
* When the timer fires, we consider the guest as hung / flatlined / dead.
* Currently we only LogRel that, but it's easy to extend this with an event in
* Main API.
*
* Should the guest reawaken at some later point, we LogRel that event and
* continue as normal. Again something which would merit an API event.
*
*/
/*********************************************************************************************************************************
* Header Files *
*********************************************************************************************************************************/
/* Enable dev_vmm Log3 statements to get IRQ-related logging. */
#define LOG_GROUP LOG_GROUP_DEV_VMM
#include <VBox/AssertGuest.h>
#include <VBox/VMMDev.h>
#include <VBox/vmm/dbgf.h>
#include <VBox/vmm/mm.h>
#include <VBox/log.h>
#include <VBox/param.h>
#include <iprt/path.h>
#include <iprt/dir.h>
#include <iprt/file.h>
#include <VBox/vmm/pgm.h>
#include <VBox/err.h>
#include <VBox/dbg.h>
#include <VBox/version.h>
#include <iprt/asm.h>
#if defined(RT_ARCH_AMD64) || defined(RT_ARCH_X86)
# include <iprt/asm-amd64-x86.h> /* ASMReadTsc */
#endif
#include <iprt/assert.h>
#include <iprt/buildconfig.h>
#include <iprt/string.h>
#include <iprt/system.h>
#include <iprt/time.h>
#ifndef IN_RC
# include <iprt/mem.h>
# include <iprt/memsafer.h>
#endif
#ifdef IN_RING3
# include <iprt/uuid.h>
#endif
#include "VMMDevState.h"
#ifdef VBOX_WITH_HGCM
# include "VMMDevHGCM.h"
#endif
#ifndef VBOX_WITHOUT_TESTING_FEATURES
# include "VMMDevTesting.h"
#endif
/*********************************************************************************************************************************
* Defined Constants And Macros *
*********************************************************************************************************************************/
#define VMMDEV_INTERFACE_VERSION_IS_1_03(s) \
( RT_HIWORD((s)->guestInfo.interfaceVersion) == 1 \
&& RT_LOWORD((s)->guestInfo.interfaceVersion) == 3 )
#define VMMDEV_INTERFACE_VERSION_IS_OK(additionsVersion) \
( RT_HIWORD(additionsVersion) == RT_HIWORD(VMMDEV_VERSION) \
&& RT_LOWORD(additionsVersion) <= RT_LOWORD(VMMDEV_VERSION) )
#define VMMDEV_INTERFACE_VERSION_IS_OLD(additionsVersion) \
( (RT_HIWORD(additionsVersion) < RT_HIWORD(VMMDEV_VERSION) \
|| ( RT_HIWORD(additionsVersion) == RT_HIWORD(VMMDEV_VERSION) \
&& RT_LOWORD(additionsVersion) <= RT_LOWORD(VMMDEV_VERSION) ) )
#define VMMDEV_INTERFACE_VERSION_IS_TOO_OLD(additionsVersion) \
( RT_HIWORD(additionsVersion) < RT_HIWORD(VMMDEV_VERSION) )
#define VMMDEV_INTERFACE_VERSION_IS_NEW(additionsVersion) \
( RT_HIWORD(additionsVersion) > RT_HIWORD(VMMDEV_VERSION) \
|| ( RT_HIWORD(additionsVersion) == RT_HIWORD(VMMDEV_VERSION) \
&& RT_LOWORD(additionsVersion) > RT_LOWORD(VMMDEV_VERSION) ) )
/** Default interval in nanoseconds between guest heartbeats.
* Used when no HeartbeatInterval is set in CFGM and for setting
* HB check timer if the guest's heartbeat frequency is less than 1Hz. */
#define VMMDEV_HEARTBEAT_DEFAULT_INTERVAL (2U*RT_NS_1SEC_64)
#ifndef VBOX_DEVICE_STRUCT_TESTCASE
#ifdef IN_RING3
/** DISPLAYCHANGEDATA field descriptors for the v18+ saved state. */
static SSMFIELD const g_aSSMDISPLAYCHANGEDATAStateFields[] =
{
SSMFIELD_ENTRY(DISPLAYCHANGEDATA, iCurrentMonitor),
SSMFIELD_ENTRY(DISPLAYCHANGEDATA, fGuestSentChangeEventAck),
SSMFIELD_ENTRY(DISPLAYCHANGEDATA, afAlignment),
SSMFIELD_ENTRY(DISPLAYCHANGEDATA, aRequests),
SSMFIELD_ENTRY_TERM()
};
/* -=-=-=-=- Misc Helpers -=-=-=-=- */
/**
* Log information about the Guest Additions.
*
* @param pGuestInfo The information we've got from the Guest Additions driver.
*/
static void vmmdevLogGuestOsInfo(VBoxGuestInfo *pGuestInfo)
{
const char *pszOs;
/* The following test applies to guest OS types which have both a 32-bit
* and a 64-bit OS type. */
switch (pGuestInfo->osType & ~VBOXOSTYPE_ArchitectureMask)
{
case VBOXOSTYPE_DOS: pszOs = "DOS"; break;
case VBOXOSTYPE_Win31: pszOs = "Windows 3.1"; break;
case VBOXOSTYPE_Win9x: pszOs = "Windows 9x"; break;
case VBOXOSTYPE_Win95: pszOs = "Windows 95"; break;
case VBOXOSTYPE_Win98: pszOs = "Windows 98"; break;
case VBOXOSTYPE_WinMe: pszOs = "Windows Me"; break;
case VBOXOSTYPE_WinNT: pszOs = "Windows NT"; break;
case VBOXOSTYPE_WinNT3x: pszOs = "Windows NT 3.x"; break;
case VBOXOSTYPE_WinNT4: pszOs = "Windows NT4"; break;
case VBOXOSTYPE_Win2k: pszOs = "Windows 2000"; break;
case VBOXOSTYPE_WinXP: pszOs = "Windows XP"; break;
case VBOXOSTYPE_Win2k3: pszOs = "Windows Server 2003"; break;
case VBOXOSTYPE_WinVista: pszOs = "Windows Vista"; break;
case VBOXOSTYPE_Win2k8: pszOs = "Windows Server 2008"; break;
case VBOXOSTYPE_Win7: pszOs = "Windows 7"; break;
case VBOXOSTYPE_Win8: pszOs = "Windows 8"; break;
case VBOXOSTYPE_Win81: pszOs = "Windows 8.1"; break;
case VBOXOSTYPE_Win10: pszOs = "Windows 10"; break;
case VBOXOSTYPE_OS2: pszOs = "OS/2"; break;
case VBOXOSTYPE_OS2Warp3: pszOs = "OS/2 Warp 3"; break;
case VBOXOSTYPE_OS2Warp4: pszOs = "OS/2 Warp 4"; break;
case VBOXOSTYPE_OS2Warp45: pszOs = "OS/2 Warp 4.5"; break;
case VBOXOSTYPE_ECS: pszOs = "OS/2 ECS"; break;
case VBOXOSTYPE_ArcaOS: pszOs = "OS/2 ArcaOS"; break;
case VBOXOSTYPE_OS21x: pszOs = "OS/2 2.1x"; break;
case VBOXOSTYPE_Linux: pszOs = "Linux"; break;
case VBOXOSTYPE_Linux22: pszOs = "Linux 2.2"; break;
case VBOXOSTYPE_Linux24: pszOs = "Linux 2.4"; break;
case VBOXOSTYPE_Linux26: pszOs = "Linux >= 2.6"; break;
case VBOXOSTYPE_ArchLinux: pszOs = "ArchLinux"; break;
case VBOXOSTYPE_Debian: pszOs = "Debian"; break;
case VBOXOSTYPE_Debian31: pszOs = "Debian 3.1"; break;
case VBOXOSTYPE_Debian4: pszOs = "Debian 4.0"; break;
case VBOXOSTYPE_Debian5: pszOs = "Debian 5.0"; break;
case VBOXOSTYPE_Debian6: pszOs = "Debian 6.0"; break;
case VBOXOSTYPE_Debian7: pszOs = "Debian 7"; break;
case VBOXOSTYPE_Debian8: pszOs = "Debian 8"; break;
case VBOXOSTYPE_Debian9: pszOs = "Debian 9"; break;
case VBOXOSTYPE_Debian10: pszOs = "Debian 10"; break;
case VBOXOSTYPE_Debian11: pszOs = "Debian 11"; break;
case VBOXOSTYPE_Debian12: pszOs = "Debian 12"; break;
case VBOXOSTYPE_OpenSUSE: pszOs = "openSUSE"; break;
case VBOXOSTYPE_OpenSUSE_Tumbleweed: pszOs = "openSUSE Tumbleweed"; break;
case VBOXOSTYPE_SUSE_LE: pszOs = "SUSE Linux Enterprise"; break;
case VBOXOSTYPE_FedoraCore: pszOs = "Fedora"; break;
case VBOXOSTYPE_Gentoo: pszOs = "Gentoo"; break;
case VBOXOSTYPE_Mandriva: pszOs = "Mandriva"; break;
case VBOXOSTYPE_OpenMandriva_Lx: pszOs = "OpenMandriva Lx"; break;
case VBOXOSTYPE_PCLinuxOS: pszOs = "PCLinuxOS"; break;
case VBOXOSTYPE_Mageia: pszOs = "Mageia"; break;
case VBOXOSTYPE_RedHat: pszOs = "Red Hat"; break;
case VBOXOSTYPE_RedHat3: pszOs = "Red Hat 3"; break;
case VBOXOSTYPE_RedHat4: pszOs = "Red Hat 4"; break;
case VBOXOSTYPE_RedHat5: pszOs = "Red Hat 5"; break;
case VBOXOSTYPE_RedHat6: pszOs = "Red Hat 6"; break;
case VBOXOSTYPE_Turbolinux: pszOs = "TurboLinux"; break;
case VBOXOSTYPE_Ubuntu: pszOs = "Ubuntu"; break;
case VBOXOSTYPE_Ubuntu10_LTS: pszOs = "Ubuntu 10.04 LTS"; break;
case VBOXOSTYPE_Ubuntu10: pszOs = "Ubuntu 10.10"; break;
case VBOXOSTYPE_Ubuntu11: pszOs = "Ubuntu 11.x"; break;
case VBOXOSTYPE_Ubuntu12_LTS: pszOs = "Ubuntu 12.04 LTS"; break;
case VBOXOSTYPE_Ubuntu12: pszOs = "Ubuntu 12.10"; break;
case VBOXOSTYPE_Ubuntu13: pszOs = "Ubuntu 13.x"; break;
case VBOXOSTYPE_Ubuntu14_LTS: pszOs = "Ubuntu 14.04 LTS"; break;
case VBOXOSTYPE_Ubuntu14: pszOs = "Ubuntu 14.10"; break;
case VBOXOSTYPE_Ubuntu15: pszOs = "Ubuntu 15.x"; break;
case VBOXOSTYPE_Ubuntu16_LTS: pszOs = "Ubuntu 16.04 LTS"; break;
case VBOXOSTYPE_Ubuntu16: pszOs = "Ubuntu 16.10"; break;
case VBOXOSTYPE_Ubuntu17: pszOs = "Ubuntu 17.x"; break;
case VBOXOSTYPE_Ubuntu18_LTS: pszOs = "Ubuntu 18.04 LTS"; break;
case VBOXOSTYPE_Ubuntu18: pszOs = "Ubuntu 18.10"; break;
case VBOXOSTYPE_Ubuntu19: pszOs = "Ubuntu 19.x"; break;
case VBOXOSTYPE_Lubuntu: pszOs = "Lubuntu"; break;
case VBOXOSTYPE_Xubuntu: pszOs = "Xubuntu"; break;
case VBOXOSTYPE_Xandros: pszOs = "Xandros"; break;
case VBOXOSTYPE_Oracle: pszOs = "Oracle Linux"; break;
case VBOXOSTYPE_Oracle4: pszOs = "Oracle Linux 4"; break;
case VBOXOSTYPE_Oracle5: pszOs = "Oracle Linux 5"; break;
case VBOXOSTYPE_Oracle6: pszOs = "Oracle Linux 6"; break;
case VBOXOSTYPE_FreeBSD: pszOs = "FreeBSD"; break;
case VBOXOSTYPE_OpenBSD: pszOs = "OpenBSD"; break;
case VBOXOSTYPE_NetBSD: pszOs = "NetBSD"; break;
case VBOXOSTYPE_Netware: pszOs = "Netware"; break;
case VBOXOSTYPE_Solaris: pszOs = "Solaris"; break;
case VBOXOSTYPE_Solaris10U8_or_later: pszOs = "Solaris 10"; break;
case VBOXOSTYPE_OpenSolaris: pszOs = "OpenSolaris"; break;
case VBOXOSTYPE_MacOS: pszOs = "Mac OS X"; break;
case VBOXOSTYPE_MacOS106: pszOs = "Mac OS X 10.6"; break;
case VBOXOSTYPE_MacOS107_x64 & ~VBOXOSTYPE_x64: pszOs = "Mac OS X 10.7"; break;
case VBOXOSTYPE_MacOS108_x64 & ~VBOXOSTYPE_x64: pszOs = "Mac OS X 10.8"; break;
case VBOXOSTYPE_MacOS109_x64 & ~VBOXOSTYPE_x64: pszOs = "Mac OS X 10.9"; break;
case VBOXOSTYPE_MacOS1010_x64 & ~VBOXOSTYPE_x64: pszOs = "Mac OS X 10.10"; break;
case VBOXOSTYPE_MacOS1011_x64 & ~VBOXOSTYPE_x64: pszOs = "Mac OS X 10.11"; break;
case VBOXOSTYPE_MacOS1012_x64 & ~VBOXOSTYPE_x64: pszOs = "macOS 10.12"; break;
case VBOXOSTYPE_MacOS1013_x64 & ~VBOXOSTYPE_x64: pszOs = "macOS 10.13"; break;
case VBOXOSTYPE_Haiku: pszOs = "Haiku"; break;
default: pszOs = "unknown"; break;
}
if (!strcmp(pszOs, "unknown"))
{
/* The following test applies to guest OS types which are 64-bit only. */
switch (pGuestInfo->osType)
{
case VBOXOSTYPE_Debian13_x64: pszOs = "Debian 13"; break;
case VBOXOSTYPE_Debian13_arm64: pszOs = "Debian 13"; break;
case VBOXOSTYPE_Ubuntu20_LTS_x64: pszOs = "Ubuntu 20.04 LTS"; break;
case VBOXOSTYPE_Ubuntu20_x64: pszOs = "Ubuntu 20.10"; break;
case VBOXOSTYPE_Ubuntu21_x64: pszOs = "Ubuntu 21.x"; break;
case VBOXOSTYPE_Ubuntu22_LTS_x64: pszOs = "Ubuntu 22.04 LTS"; break;
case VBOXOSTYPE_Ubuntu22_x64: pszOs = "Ubuntu 22.10"; break;
case VBOXOSTYPE_Ubuntu22_arm64: pszOs = "Ubuntu 22.10"; break;
case VBOXOSTYPE_Ubuntu23_x64: pszOs = "Ubuntu 23.04"; break;
case VBOXOSTYPE_Ubuntu23_arm64: pszOs = "Ubuntu 23.04"; break;
case VBOXOSTYPE_Ubuntu231_x64: pszOs = "Ubuntu 23.10"; break;
case VBOXOSTYPE_Ubuntu231_arm64: pszOs = "Ubuntu 23.10"; break;
case VBOXOSTYPE_Ubuntu24_LTS_x64: pszOs = "Ubuntu 24.04 LTS"; break;
case VBOXOSTYPE_Ubuntu24_LTS_arm64: pszOs = "Ubuntu 24.04 LTS"; break;
case VBOXOSTYPE_Ubuntu24_x64: pszOs = "Ubuntu 24.10"; break;
case VBOXOSTYPE_Ubuntu24_arm64: pszOs = "Ubuntu 24.10"; break;
case VBOXOSTYPE_Ubuntu25_x64: pszOs = "Ubuntu 25.04"; break;
case VBOXOSTYPE_Ubuntu25_arm64: pszOs = "Ubuntu 25.04"; break;
case VBOXOSTYPE_RedHat7_x64: pszOs = "Red Hat 7"; break;
case VBOXOSTYPE_RedHat7_arm64: pszOs = "Red Hat 7"; break;
case VBOXOSTYPE_RedHat8_x64: pszOs = "Red Hat 8"; break;
case VBOXOSTYPE_RedHat8_arm64: pszOs = "Red Hat 8"; break;
case VBOXOSTYPE_RedHat9_x64: pszOs = "Red Hat 9"; break;
case VBOXOSTYPE_RedHat9_arm64: pszOs = "Red Hat 9"; break;
case VBOXOSTYPE_RedHat10_x64: pszOs = "Red Hat 10"; break;
case VBOXOSTYPE_RedHat10_arm64: pszOs = "Red Hat 10"; break;
case VBOXOSTYPE_Oracle7_x64: pszOs = "Oracle Linux 7"; break;
case VBOXOSTYPE_Oracle7_arm64: pszOs = "Oracle Linux 7"; break;
case VBOXOSTYPE_Oracle8_x64: pszOs = "Oracle Linux 8"; break;
case VBOXOSTYPE_Oracle8_arm64: pszOs = "Oracle Linux 8"; break;
case VBOXOSTYPE_Oracle9_x64: pszOs = "Oracle Linux 9"; break;
case VBOXOSTYPE_Oracle9_arm64: pszOs = "Oracle Linux 9"; break;
case VBOXOSTYPE_Oracle10_x64: pszOs = "Oracle Linux 10"; break;
case VBOXOSTYPE_Oracle10_arm64: pszOs = "Oracle Linux 10"; break;
case VBOXOSTYPE_OpenSUSE_Leap_x64: pszOs = "openSUSE Leap"; break;
case VBOXOSTYPE_OpenSUSE_Leap_arm64: pszOs = "openSUSE Leap"; break;
case VBOXOSTYPE_Solaris11_x64: pszOs = "Solaris 11"; break;
case VBOXOSTYPE_VBoxBS_x64: pszOs = "VBox Bootsector"; break;
case VBOXOSTYPE_Win2k12_x64: pszOs = "Windows Server 2012"; break;
case VBOXOSTYPE_Win2k16_x64: pszOs = "Windows Server 2016"; break;
case VBOXOSTYPE_Win2k19_x64: pszOs = "Windows Server 2019"; break;
case VBOXOSTYPE_Win2k22_x64: pszOs = "Windows Server 2022"; break;
case VBOXOSTYPE_Win2k25_x64: pszOs = "Windows Server 2025"; break;
case VBOXOSTYPE_Win11_x64: pszOs = "Windows 11"; break;
case VBOXOSTYPE_Win11_arm64: pszOs = "Windows 11"; break;
default: pszOs = "unknown"; break;
}
}
LogRel(("VMMDev: Guest Additions information report: Interface = 0x%08X osType = 0x%08X (%s, %u-bit)\n",
pGuestInfo->interfaceVersion, pGuestInfo->osType, pszOs,
pGuestInfo->osType & VBOXOSTYPE_x64 ? 64 : 32));
}
/**
* Sets the IRQ (raise it or lower it) for 1.03 additions.
*
* @param pDevIns The device instance.
* @param pThis The VMMDev shared instance data.
* @param pThisCC The VMMDev ring-3 instance data.
* @thread Any.
* @remarks Must be called owning the critical section.
*/
static void vmmdevSetIRQ_Legacy(PPDMDEVINS pDevIns, PVMMDEV pThis, PVMMDEVCC pThisCC)
{
if (pThis->fu32AdditionsOk)
{
/* Filter unsupported events */
uint32_t fEvents = pThis->fHostEventFlags & pThisCC->CTX_SUFF(pVMMDevRAM)->V.V1_03.u32GuestEventMask;
Log(("vmmdevSetIRQ: fEvents=%#010x, fHostEventFlags=%#010x, u32GuestEventMask=%#010x.\n",
fEvents, pThis->fHostEventFlags, pThisCC->CTX_SUFF(pVMMDevRAM)->V.V1_03.u32GuestEventMask));
/* Move event flags to VMMDev RAM */
pThisCC->CTX_SUFF(pVMMDevRAM)->V.V1_03.u32HostEvents = fEvents;
uint32_t uIRQLevel = 0;
if (fEvents)
{
/* Clear host flags which will be delivered to guest. */
pThis->fHostEventFlags &= ~fEvents;
Log(("vmmdevSetIRQ: fHostEventFlags=%#010x\n", pThis->fHostEventFlags));
uIRQLevel = 1;
}
/* Set IRQ level for pin 0 (see NoWait comment in vmmdevMaybeSetIRQ). */
/** @todo make IRQ pin configurable, at least a symbolic constant */
PDMDevHlpPCISetIrqNoWait(pDevIns, 0, uIRQLevel);
Log(("vmmdevSetIRQ: IRQ set %d\n", uIRQLevel));
}
else
Log(("vmmdevSetIRQ: IRQ is not generated, guest has not yet reported to us.\n"));
}
/**
* Sets the IRQ if there are events to be delivered.
*
* @param pDevIns The device instance.
* @param pThis The VMMDev shared instance data.
* @param pThisCC The VMMDev ring-3 instance data.
* @thread Any.
* @remarks Must be called owning the critical section.
*/
static void vmmdevMaybeSetIRQ(PPDMDEVINS pDevIns, PVMMDEV pThis, PVMMDEVCC pThisCC)
{
Log3(("vmmdevMaybeSetIRQ: fHostEventFlags=%#010x, fGuestFilterMask=%#010x.\n",
pThis->fHostEventFlags, pThis->fGuestFilterMask));
if (pThis->fHostEventFlags & pThis->fGuestFilterMask)
{
/*
* Note! No need to wait for the IRQs to be set (if we're not luck
* with the locks, etc). It is a notification about something,
* which has already happened.
*/
pThisCC->pVMMDevRAMR3->V.V1_04.fHaveEvents = true;
PDMDevHlpPCISetIrqNoWait(pDevIns, 0, 1);
Log3(("vmmdevMaybeSetIRQ: IRQ set.\n"));
}
}
/**
* Notifies the guest about new events (@a fAddEvents).
*
* @param pDevIns The device instance.
* @param pThis The VMMDev shared instance data.
* @param pThisCC The VMMDev ring-3 instance data.
* @param fAddEvents New events to add.
* @thread Any.
* @remarks Must be called owning the critical section.
*/
static void vmmdevNotifyGuestWorker(PPDMDEVINS pDevIns, PVMMDEV pThis, PVMMDEVCC pThisCC, uint32_t fAddEvents)
{
Log3(("vmmdevNotifyGuestWorker: fAddEvents=%#010x.\n", fAddEvents));
Assert(PDMDevHlpCritSectIsOwner(pDevIns, &pThis->CritSect));
if (!VMMDEV_INTERFACE_VERSION_IS_1_03(pThis))
{
Log3(("vmmdevNotifyGuestWorker: New additions detected.\n"));
if (pThis->fu32AdditionsOk)
{
const bool fHadEvents = (pThis->fHostEventFlags & pThis->fGuestFilterMask) != 0;
Log3(("vmmdevNotifyGuestWorker: fHadEvents=%d, fHostEventFlags=%#010x, fGuestFilterMask=%#010x.\n",
fHadEvents, pThis->fHostEventFlags, pThis->fGuestFilterMask));
pThis->fHostEventFlags |= fAddEvents;
if (!fHadEvents)
vmmdevMaybeSetIRQ(pDevIns, pThis, pThisCC);
}
else
{
pThis->fHostEventFlags |= fAddEvents;
Log(("vmmdevNotifyGuestWorker: IRQ is not generated, guest has not yet reported to us.\n"));
}
}
else
{
Log3(("vmmdevNotifyGuestWorker: Old additions detected.\n"));
pThis->fHostEventFlags |= fAddEvents;
vmmdevSetIRQ_Legacy(pDevIns, pThis, pThisCC);
}
}
/* -=-=-=-=- Interfaces shared with VMMDevHGCM.cpp -=-=-=-=- */
/**
* Notifies the guest about new events (@a fAddEvents).
*
* This is used by VMMDev.cpp as well as VMMDevHGCM.cpp.
*
* @param pDevIns The device instance.
* @param pThis The VMMDev shared instance data.
* @param pThisCC The VMMDev ring-3 instance data.
* @param fAddEvents New events to add.
* @thread Any.
*/
void VMMDevNotifyGuest(PPDMDEVINS pDevIns, PVMMDEV pThis, PVMMDEVCC pThisCC, uint32_t fAddEvents)
{
Log3(("VMMDevNotifyGuest: fAddEvents=%#010x\n", fAddEvents));
/*
* Only notify the VM when it's running.
*/
VMSTATE enmVMState = PDMDevHlpVMState(pDevIns);
if ( enmVMState == VMSTATE_RUNNING
|| enmVMState == VMSTATE_RUNNING_LS
|| enmVMState == VMSTATE_LOADING
|| enmVMState == VMSTATE_RESUMING
|| enmVMState == VMSTATE_SUSPENDING
|| enmVMState == VMSTATE_SUSPENDING_LS
|| enmVMState == VMSTATE_SUSPENDING_EXT_LS
|| enmVMState == VMSTATE_DEBUGGING
|| enmVMState == VMSTATE_DEBUGGING_LS
)
{
int const rcLock = PDMDevHlpCritSectEnter(pDevIns, &pThis->CritSect, VERR_IGNORED);
PDM_CRITSECT_RELEASE_ASSERT_RC_DEV(pDevIns, &pThis->CritSect, rcLock);
vmmdevNotifyGuestWorker(pDevIns, pThis, pThisCC, fAddEvents);
PDMDevHlpCritSectLeave(pDevIns, &pThis->CritSect);
}
else
LogRel(("VMMDevNotifyGuest: fAddEvents=%#x ignored because enmVMState=%d\n", fAddEvents, enmVMState));
}
/**
* Code shared by VMMDevReq_CtlGuestFilterMask and HGCM for controlling the
* events the guest are interested in.
*
* @param pDevIns The device instance.
* @param pThis The VMMDev shared instance data.
* @param pThisCC The VMMDev ring-3 instance data.
* @param fOrMask Events to add (VMMDEV_EVENT_XXX). Pass 0 for no
* change.
* @param fNotMask Events to remove (VMMDEV_EVENT_XXX). Pass 0 for no
* change.
*
* @remarks When HGCM will automatically enable VMMDEV_EVENT_HGCM when the guest
* starts submitting HGCM requests. Otherwise, the events are
* controlled by the guest.
*/
void VMMDevCtlSetGuestFilterMask(PPDMDEVINS pDevIns, PVMMDEV pThis, PVMMDEVCC pThisCC, uint32_t fOrMask, uint32_t fNotMask)
{
int const rcLock = PDMDevHlpCritSectEnter(pDevIns, &pThis->CritSect, VERR_IGNORED);
PDM_CRITSECT_RELEASE_ASSERT_RC_DEV(pDevIns, &pThis->CritSect, rcLock);
const bool fHadEvents = (pThis->fHostEventFlags & pThis->fGuestFilterMask) != 0;
Log(("VMMDevCtlSetGuestFilterMask: fOrMask=%#010x, u32NotMask=%#010x, fHadEvents=%d.\n", fOrMask, fNotMask, fHadEvents));
if (fHadEvents)
{
if (!pThis->fNewGuestFilterMaskValid)
pThis->fNewGuestFilterMask = pThis->fGuestFilterMask;
pThis->fNewGuestFilterMask |= fOrMask;
pThis->fNewGuestFilterMask &= ~fNotMask;
pThis->fNewGuestFilterMaskValid = true;
}
else
{
pThis->fGuestFilterMask |= fOrMask;
pThis->fGuestFilterMask &= ~fNotMask;
vmmdevMaybeSetIRQ(pDevIns, pThis, pThisCC);
}
PDMDevHlpCritSectLeave(pDevIns, &pThis->CritSect);
}
/* -=-=-=-=- Request processing functions. -=-=-=-=- */
/**
* Handles VMMDevReq_ReportGuestInfo.
*
* @returns VBox status code that the guest should see.
* @param pDevIns The device instance.
* @param pThis The VMMDev shared instance data.
* @param pThisCC The VMMDev ring-3 instance data.
* @param pRequestHeader The header of the request to handle.
*/
static int vmmdevReqHandler_ReportGuestInfo(PPDMDEVINS pDevIns, PVMMDEV pThis, PVMMDEVCC pThisCC,
VMMDevRequestHeader *pRequestHeader)
{
AssertMsgReturn(pRequestHeader->size == sizeof(VMMDevReportGuestInfo), ("%u\n", pRequestHeader->size), VERR_INVALID_PARAMETER);
VBoxGuestInfo const *pInfo = &((VMMDevReportGuestInfo *)pRequestHeader)->guestInfo;
if (memcmp(&pThis->guestInfo, pInfo, sizeof(*pInfo)) != 0)
{
/* Make a copy of supplied information. */
pThis->guestInfo = *pInfo;
/* Check additions interface version. */
pThis->fu32AdditionsOk = VMMDEV_INTERFACE_VERSION_IS_OK(pThis->guestInfo.interfaceVersion);
vmmdevLogGuestOsInfo(&pThis->guestInfo);
if (pThisCC->pDrv && pThisCC->pDrv->pfnUpdateGuestInfo)
pThisCC->pDrv->pfnUpdateGuestInfo(pThisCC->pDrv, &pThis->guestInfo);
}
if (!pThis->fu32AdditionsOk)
return VERR_VERSION_MISMATCH;
/* Clear our IRQ in case it was high for whatever reason. */
PDMDevHlpPCISetIrqNoWait(pDevIns, 0, 0);
return VINF_SUCCESS;
}
/**
* Handles VMMDevReq_GuestHeartbeat.
*
* @returns VBox status code that the guest should see.
* @param pDevIns The device instance.
* @param pThis The VMMDev shared instance data.
*/
static int vmmDevReqHandler_GuestHeartbeat(PPDMDEVINS pDevIns, PVMMDEV pThis)
{
int rc;
if (pThis->fHeartbeatActive)
{
uint64_t const nsNowTS = PDMDevHlpTimerGetNano(pDevIns, pThis->hFlatlinedTimer);
if (!pThis->fFlatlined)
{ /* likely */ }
else
{
LogRel(("VMMDev: GuestHeartBeat: Guest is alive (gone %'llu ns)\n", nsNowTS - pThis->nsLastHeartbeatTS));
ASMAtomicWriteBool(&pThis->fFlatlined, false);
}
ASMAtomicWriteU64(&pThis->nsLastHeartbeatTS, nsNowTS);
/* Postpone (or restart if we missed a beat) the timeout timer. */
rc = PDMDevHlpTimerSetNano(pDevIns, pThis->hFlatlinedTimer, pThis->cNsHeartbeatTimeout);
}
else
rc = VINF_SUCCESS;
return rc;
}
/**
* Timer that fires when where have been no heartbeats for a given time.
*
* @remarks Does not take the VMMDev critsect.
*/
static DECLCALLBACK(void) vmmDevHeartbeatFlatlinedTimer(PPDMDEVINS pDevIns, TMTIMERHANDLE hTimer, void *pvUser)
{
PVMMDEV pThis = (PVMMDEV)pvUser;
Assert(hTimer == pThis->hFlatlinedTimer);
if (pThis->fHeartbeatActive)
{
uint64_t cNsElapsed = PDMDevHlpTimerGetNano(pDevIns, hTimer) - pThis->nsLastHeartbeatTS;
if ( !pThis->fFlatlined
&& cNsElapsed >= pThis->cNsHeartbeatInterval)
{
LogRel(("VMMDev: vmmDevHeartbeatFlatlinedTimer: Guest seems to be unresponsive. Last heartbeat received %RU64 seconds ago\n",
cNsElapsed / RT_NS_1SEC));
ASMAtomicWriteBool(&pThis->fFlatlined, true);
}
}
}
/**
* Handles VMMDevReq_HeartbeatConfigure.
*
* @returns VBox status code that the guest should see.
* @param pDevIns The device instance.
* @param pThis The VMMDev shared instance data.
* @param pReqHdr The header of the request to handle.
*/
static int vmmDevReqHandler_HeartbeatConfigure(PPDMDEVINS pDevIns, PVMMDEV pThis, VMMDevRequestHeader *pReqHdr)
{
AssertMsgReturn(pReqHdr->size == sizeof(VMMDevReqHeartbeat), ("%u\n", pReqHdr->size), VERR_INVALID_PARAMETER);
VMMDevReqHeartbeat *pReq = (VMMDevReqHeartbeat *)pReqHdr;
int rc;
pReq->cNsInterval = pThis->cNsHeartbeatInterval;
if (pReq->fEnabled != pThis->fHeartbeatActive)
{
ASMAtomicWriteBool(&pThis->fHeartbeatActive, pReq->fEnabled);
if (pReq->fEnabled)
{
/*
* Activate the heartbeat monitor.
*/
pThis->nsLastHeartbeatTS = PDMDevHlpTimerGetNano(pDevIns, pThis->hFlatlinedTimer);
rc = PDMDevHlpTimerSetNano(pDevIns, pThis->hFlatlinedTimer, pThis->cNsHeartbeatTimeout);
if (RT_SUCCESS(rc))
LogRel(("VMMDev: Heartbeat flatline timer set to trigger after %'RU64 ns\n", pThis->cNsHeartbeatTimeout));
else
LogRel(("VMMDev: Error starting flatline timer (heartbeat): %Rrc\n", rc));
}
else
{
/*
* Deactivate the heartbeat monitor.
*/
rc = PDMDevHlpTimerStop(pDevIns, pThis->hFlatlinedTimer);
LogRel(("VMMDev: Heartbeat checking timer has been stopped (rc=%Rrc)\n", rc));
}
}
else
{
LogRel(("VMMDev: vmmDevReqHandler_HeartbeatConfigure: No change (fHeartbeatActive=%RTbool)\n", pThis->fHeartbeatActive));
rc = VINF_SUCCESS;
}
return rc;
}
/**
* Handles VMMDevReq_NtBugCheck.
*
* @returns VBox status code that the guest should see.
* @param pDevIns The device instance.
* @param pReqHdr The header of the request to handle.
*/
static int vmmDevReqHandler_NtBugCheck(PPDMDEVINS pDevIns, VMMDevRequestHeader *pReqHdr)
{
if (pReqHdr->size == sizeof(VMMDevReqNtBugCheck))
{
VMMDevReqNtBugCheck const *pReq = (VMMDevReqNtBugCheck const *)pReqHdr;
PDMDevHlpDBGFReportBugCheck(pDevIns, DBGFEVENT_BSOD_VMMDEV,
pReq->uBugCheck, pReq->auParameters[0], pReq->auParameters[1],
pReq->auParameters[2], pReq->auParameters[3]);
}
else if (pReqHdr->size == sizeof(VMMDevRequestHeader))
{
LogRel(("VMMDev: NT BugCheck w/o data.\n"));
PDMDevHlpDBGFReportBugCheck(pDevIns, DBGFEVENT_BSOD_VMMDEV, 0, 0, 0, 0, 0);
}
else
return VERR_INVALID_PARAMETER;
return VINF_SUCCESS;
}
/**
* Validates a publisher tag.
*
* @returns true / false.
* @param pszTag Tag to validate.
*/
static bool vmmdevReqIsValidPublisherTag(const char *pszTag)
{
/* Note! This character set is also found in Config.kmk. */
static char const s_szValidChars[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789abcdefghijklmnopqrstuvwxyz()[]{}+-.,";
while (*pszTag != '\0')
{
if (!strchr(s_szValidChars, *pszTag))
return false;
pszTag++;
}
return true;
}
/**
* Validates a build tag.
*
* @returns true / false.
* @param pszTag Tag to validate.
*/
static bool vmmdevReqIsValidBuildTag(const char *pszTag)
{
int cchPrefix;
if (!strncmp(pszTag, "RC", 2))
cchPrefix = 2;
else if (!strncmp(pszTag, "BETA", 4))
cchPrefix = 4;
else if (!strncmp(pszTag, "ALPHA", 5))
cchPrefix = 5;
else
return false;
if (pszTag[cchPrefix] == '\0')
return true;
uint8_t u8;
int rc = RTStrToUInt8Full(&pszTag[cchPrefix], 10, &u8);
return rc == VINF_SUCCESS;
}
/**
* Handles VMMDevReq_ReportGuestInfo2.
*
* @returns VBox status code that the guest should see.
* @param pDevIns The device instance.
* @param pThis The VMMDev shared instance data.
* @param pThisCC The VMMDev ring-3 instance data.
* @param pReqHdr The header of the request to handle.
*/
static int vmmdevReqHandler_ReportGuestInfo2(PPDMDEVINS pDevIns, PVMMDEV pThis, PVMMDEVCC pThisCC, VMMDevRequestHeader *pReqHdr)
{
AssertMsgReturn(pReqHdr->size == sizeof(VMMDevReportGuestInfo2), ("%u\n", pReqHdr->size), VERR_INVALID_PARAMETER);
VBoxGuestInfo2 const *pInfo2 = &((VMMDevReportGuestInfo2 *)pReqHdr)->guestInfo;
LogRel(("VMMDev: Guest Additions information report: Version %d.%d.%d r%d '%.*s'\n",
pInfo2->additionsMajor, pInfo2->additionsMinor, pInfo2->additionsBuild,
pInfo2->additionsRevision, sizeof(pInfo2->szName), pInfo2->szName));
/* The interface was introduced in 3.2 and will definitely not be
backported beyond 3.0 (bird). */
AssertMsgReturn(pInfo2->additionsMajor >= 3,
("%u.%u.%u\n", pInfo2->additionsMajor, pInfo2->additionsMinor, pInfo2->additionsBuild),
VERR_INVALID_PARAMETER);
/* The version must fit in a full version compression. */
uint32_t uFullVersion = VBOX_FULL_VERSION_MAKE(pInfo2->additionsMajor, pInfo2->additionsMinor, pInfo2->additionsBuild);
AssertMsgReturn( VBOX_FULL_VERSION_GET_MAJOR(uFullVersion) == pInfo2->additionsMajor
&& VBOX_FULL_VERSION_GET_MINOR(uFullVersion) == pInfo2->additionsMinor
&& VBOX_FULL_VERSION_GET_BUILD(uFullVersion) == pInfo2->additionsBuild,
("%u.%u.%u\n", pInfo2->additionsMajor, pInfo2->additionsMinor, pInfo2->additionsBuild),
VERR_OUT_OF_RANGE);
/*
* Validate the name.
* Be less strict towards older additions (< v4.1.50).
*/
AssertCompile(sizeof(pThis->guestInfo2.szName) == sizeof(pInfo2->szName));
AssertReturn(RTStrEnd(pInfo2->szName, sizeof(pInfo2->szName)) != NULL, VERR_INVALID_PARAMETER);
const char *pszName = pInfo2->szName;
/* The version number which shouldn't be there. */
char szTmp[sizeof(pInfo2->szName)];
size_t cchStart = RTStrPrintf(szTmp, sizeof(szTmp), "%u.%u.%u", pInfo2->additionsMajor, pInfo2->additionsMinor, pInfo2->additionsBuild);
AssertMsgReturn(!strncmp(pszName, szTmp, cchStart), ("%s != %s\n", pszName, szTmp), VERR_INVALID_PARAMETER);
pszName += cchStart;
/* Now we can either have nothing or a build tag or/and a publisher tag. */
if (*pszName != '\0')
{
const char *pszRelaxedName = "";
bool const fStrict = pInfo2->additionsMajor > 4
|| (pInfo2->additionsMajor == 4 && pInfo2->additionsMinor > 1)
|| (pInfo2->additionsMajor == 4 && pInfo2->additionsMinor == 1 && pInfo2->additionsBuild >= 50);
bool fOk = false;
if (*pszName == '_')
{
pszName++;
strcpy(szTmp, pszName);
char *pszTag2 = strchr(szTmp, '_');
if (!pszTag2)
{
fOk = vmmdevReqIsValidBuildTag(szTmp)
|| vmmdevReqIsValidPublisherTag(szTmp);
}
else
{
*pszTag2++ = '\0';
fOk = vmmdevReqIsValidBuildTag(szTmp);
if (fOk)
{
fOk = vmmdevReqIsValidPublisherTag(pszTag2);
if (!fOk)
pszRelaxedName = szTmp;
}
}
}
if (!fOk)
{
AssertLogRelMsgReturn(!fStrict, ("%s", pszName), VERR_INVALID_PARAMETER);
/* non-strict mode, just zap the extra stuff. */
LogRel(("VMMDev: ReportGuestInfo2: Ignoring unparsable version name bits: '%s' -> '%s'.\n", pszName, pszRelaxedName));
pszName = pszRelaxedName;
}
}
/*
* Save the info and tell Main or whoever is listening.
*/
pThis->guestInfo2.uFullVersion = uFullVersion;
pThis->guestInfo2.uRevision = pInfo2->additionsRevision;
pThis->guestInfo2.fFeatures = pInfo2->additionsFeatures;
strcpy(pThis->guestInfo2.szName, pszName);
if (pThisCC->pDrv && pThisCC->pDrv->pfnUpdateGuestInfo2)
pThisCC->pDrv->pfnUpdateGuestInfo2(pThisCC->pDrv, uFullVersion, pszName, pInfo2->additionsRevision,
pInfo2->additionsFeatures);
/* Clear our IRQ in case it was high for whatever reason. */
PDMDevHlpPCISetIrqNoWait(pDevIns, 0, 0);
return VINF_SUCCESS;
}
/**
* Allocates a new facility status entry, initializing it to inactive.
*
* @returns Pointer to a facility status entry on success, NULL on failure
* (table full).
* @param pThis The VMMDev shared instance data.
* @param enmFacility The facility type code.
* @param fFixed This is set when allocating the standard entries
* from the constructor.
* @param pTimeSpecNow Optionally giving the entry timestamp to use (ctor).
*/
static PVMMDEVFACILITYSTATUSENTRY
vmmdevAllocFacilityStatusEntry(PVMMDEV pThis, VBoxGuestFacilityType enmFacility, bool fFixed, PCRTTIMESPEC pTimeSpecNow)
{
/* If full, expunge one inactive entry. */
if (pThis->cFacilityStatuses == RT_ELEMENTS(pThis->aFacilityStatuses))
{
uint32_t i = pThis->cFacilityStatuses;
while (i-- > 0)
{
if ( pThis->aFacilityStatuses[i].enmStatus == VBoxGuestFacilityStatus_Inactive
&& !pThis->aFacilityStatuses[i].fFixed)
{
pThis->cFacilityStatuses--;
int cToMove = pThis->cFacilityStatuses - i;
if (cToMove)
memmove(&pThis->aFacilityStatuses[i], &pThis->aFacilityStatuses[i + 1],
cToMove * sizeof(pThis->aFacilityStatuses[i]));
RT_ZERO(pThis->aFacilityStatuses[pThis->cFacilityStatuses]);
break;
}
}
if (pThis->cFacilityStatuses == RT_ELEMENTS(pThis->aFacilityStatuses))
return NULL;
}
/* Find location in array (it's sorted). */
uint32_t i = pThis->cFacilityStatuses;
while (i-- > 0)
if ((uint32_t)pThis->aFacilityStatuses[i].enmFacility < (uint32_t)enmFacility)
break;
i++;
/* Move. */
int cToMove = pThis->cFacilityStatuses - i;
if (cToMove > 0)
memmove(&pThis->aFacilityStatuses[i + 1], &pThis->aFacilityStatuses[i],
cToMove * sizeof(pThis->aFacilityStatuses[i]));
pThis->cFacilityStatuses++;
/* Initialize. */
pThis->aFacilityStatuses[i].enmFacility = enmFacility;
pThis->aFacilityStatuses[i].enmStatus = VBoxGuestFacilityStatus_Inactive;
pThis->aFacilityStatuses[i].fFixed = fFixed;
pThis->aFacilityStatuses[i].afPadding[0] = 0;
pThis->aFacilityStatuses[i].afPadding[1] = 0;
pThis->aFacilityStatuses[i].afPadding[2] = 0;
pThis->aFacilityStatuses[i].fFlags = 0;
if (pTimeSpecNow)
pThis->aFacilityStatuses[i].TimeSpecTS = *pTimeSpecNow;
else
RTTimeSpecSetNano(&pThis->aFacilityStatuses[i].TimeSpecTS, 0);
return &pThis->aFacilityStatuses[i];
}
/**
* Gets a facility status entry, allocating a new one if not already present.
*
* @returns Pointer to a facility status entry on success, NULL on failure
* (table full).
* @param pThis The VMMDev shared instance data.
* @param enmFacility The facility type code.
*/
static PVMMDEVFACILITYSTATUSENTRY vmmdevGetFacilityStatusEntry(PVMMDEV pThis, VBoxGuestFacilityType enmFacility)
{
/** @todo change to binary search. */
uint32_t i = pThis->cFacilityStatuses;
while (i-- > 0)
{
if (pThis->aFacilityStatuses[i].enmFacility == enmFacility)
return &pThis->aFacilityStatuses[i];
if ((uint32_t)pThis->aFacilityStatuses[i].enmFacility < (uint32_t)enmFacility)
break;
}
return vmmdevAllocFacilityStatusEntry(pThis, enmFacility, false /*fFixed*/, NULL);
}
/**
* Handles VMMDevReq_ReportGuestStatus.
*
* @returns VBox status code that the guest should see.
* @param pThis The VMMDev shared instance data.
* @param pThisCC The VMMDev ring-3 instance data.
* @param pReqHdr The header of the request to handle.
*/
static int vmmdevReqHandler_ReportGuestStatus(PVMMDEV pThis, PVMMDEVCC pThisCC, VMMDevRequestHeader *pReqHdr)
{
/*
* Validate input.
*/
AssertMsgReturn(pReqHdr->size == sizeof(VMMDevReportGuestStatus), ("%u\n", pReqHdr->size), VERR_INVALID_PARAMETER);
VBoxGuestStatus *pStatus = &((VMMDevReportGuestStatus *)pReqHdr)->guestStatus;
AssertMsgReturn( pStatus->facility > VBoxGuestFacilityType_Unknown
&& pStatus->facility <= VBoxGuestFacilityType_All,
("%d\n", pStatus->facility),
VERR_INVALID_PARAMETER);
AssertMsgReturn(pStatus->status == (VBoxGuestFacilityStatus)(uint16_t)pStatus->status,
("%#x (%u)\n", pStatus->status, pStatus->status),
VERR_OUT_OF_RANGE);
/*
* Do the update.
*/
RTTIMESPEC Now;
RTTimeNow(&Now);
if (pStatus->facility == VBoxGuestFacilityType_All)
{
uint32_t i = pThis->cFacilityStatuses;