TimeSync: Added reference counter adjustments

Goldfish64 · Goldfish64 · commit b383eb829962 · 2022-09-29T10:43:10.000-05:00
diff --git a/Changelog.md b/Changelog.md
@@ -8,6 +8,8 @@ MacHyperVSupport Changelog
 - Fixed intermittent hangs in storage and network drivers
 - Added support for storage disk addition and removal while VM is running
 - Added support for guest restart via Restart-VM
+- Renamed hvshutdown daemon to hvutil to support all userspace-side functions
+- Added guest time synchronization support
 
 #### v0.9.1
 - Added initial PCI passthrough support
diff --git a/MacHyperVSupport/Controller/HyperV.hpp b/MacHyperVSupport/Controller/HyperV.hpp
@@ -406,8 +406,6 @@ constexpr size_t ARRAY_SIZE(const T (&array)[N]) {
 //
 // Hyper-V CPUID feature support
 //
-#define MSR_HV_TIME_REF_COUNT    0x40000020
-
 #define kHyperVCpuidMsrTimeRefCnt      0x0002
 #define kHyperVCpuidMsrSynIC           0x0004
 #define kHyperVCpuidMsrSynTimer        0x0008
@@ -423,7 +421,7 @@ constexpr size_t ARRAY_SIZE(const T (&array)[N]) {
 //
 // Hyper-V MSRs
 //
-#define kHyperVMsrGuestID                     0x40000000
+#define kHyperVMsrGuestID                       0x40000000
 #define kHyperVMsrGuestIDBuildMask              0xFFFFULL
 #define kHyperVMsrGuestIDServicePackMask        0x0000000000FF0000ULL
 #define kHyperVMsrGuestIDServicePackShift       16
@@ -444,6 +442,8 @@ constexpr size_t ARRAY_SIZE(const T (&array)[N]) {
 
 #define kHyperVMsrVPIndex                       0x40000002
 
+#define kHyperVMsrTimeRefCount                  0x40000020
+
 #define kHyperVMsrReferenceTsc                  0x40000021
 #define kHyperVMsrReferenceTscEnable            0x0001ULL
 #define kHyperVMsrReferenceTscRsvdMask          0x0FFEULL
diff --git a/MacHyperVSupport/Controller/HyperVController.hpp b/MacHyperVSupport/Controller/HyperVController.hpp
@@ -124,6 +124,12 @@ class HyperVController : public IOService {
   void disableInterrupts();
   void sendSynICEOM(UInt32 cpu);
   
+  //
+  // Time reference counter.
+  //
+  inline bool isTimeRefCounterSupported() { return (_hvFeatures & kHyperVCpuidMsrTimeRefCnt); }
+  inline UInt64 readTimeRefCounter() { return isTimeRefCounterSupported() ? rdmsr64(kHyperVMsrTimeRefCount) : 0; }
+
   //
   // Messages.
   //
diff --git a/MacHyperVSupport/IntegrationComponents/Shutdown/HyperVShutdown.cpp b/MacHyperVSupport/IntegrationComponents/Shutdown/HyperVShutdown.cpp
@@ -95,7 +95,7 @@ bool HyperVShutdown::handleShutdown(VMBusICMessageShutdownData *shutdownData) {
   //
   // Send message to userclients to see if we can shutdown.
   //
-  result = _hvDevice->checkUserClient();
+  result = _hvDevice->getHvController()->checkUserClient();
   if (result) {
     result = performShutdown(shutdownData, false);
     if (!result) {
@@ -115,15 +115,15 @@ bool HyperVShutdown::performShutdown(VMBusICMessageShutdownData *shutdownData, b
     case kVMBusICShutdownFlagsShutdownForced:
       if (doShutdown) {
         HVDBGLOG("Performing shutdown");
-        _hvDevice->notifyUserClient(kHyperVUserClientNotificationTypePerformShutdown, nullptr, 0);
+        _hvDevice->getHvController()->notifyUserClient(kHyperVUserClientNotificationTypePerformShutdown, nullptr, 0);
       }
       break;
 
     case kVMBusICShutdownFlagsRestart:
     case kVMBusICShutdownFlagsRestartForced:
       if (doShutdown) {
         HVDBGLOG("Performing restart");
-        _hvDevice->notifyUserClient(kHyperVUserClientNotificationTypePerformRestart, nullptr, 0);
+        _hvDevice->getHvController()->notifyUserClient(kHyperVUserClientNotificationTypePerformRestart, nullptr, 0);
       }
       break;
 
diff --git a/MacHyperVSupport/IntegrationComponents/TimeSync/HyperVTimeSync.cpp b/MacHyperVSupport/IntegrationComponents/TimeSync/HyperVTimeSync.cpp
@@ -91,20 +91,29 @@ void HyperVTimeSync::handlePacket(VMBusPacketHeader *pktHeader, UInt32 pktHeader
 
 void HyperVTimeSync::handleTimeAdjust(UInt64 hostTime, UInt64 referenceTime, VMBusICTimeSyncFlags flags) {
   UInt64 hvTimeNs;
+  UInt64 hvRefTimeAdjust = 0;
   HyperVUserClientTimeData timeData;
 
   HVDBGLOG("Time sync request %u received (host time: %llu, ref time: %llu)", flags, hostTime, referenceTime);
 
   if (flags != kVMBusICTimeSyncFlagsSync) {
     return;
   }
+  
+  //
+  // Adjust time based on provided and current reference counter.
+  //
+  if (referenceTime != 0 && _hvDevice->getHvController()->isTimeRefCounterSupported()) {
+    hvRefTimeAdjust = _hvDevice->getHvController()->readTimeRefCounter() - referenceTime;
+    HVDBGLOG("Time sync will be adjusted by %llu", hvRefTimeAdjust);
+  }
 
   //
   // Calculate epoch and break out into seconds and microseconds remainder.
   //
-  hvTimeNs = (hostTime - kHyperVTimeSyncTimeBase) * kHyperVTimerNanosecondFactor;
+  hvTimeNs = (hostTime - kHyperVTimeSyncTimeBase + hvRefTimeAdjust) * kHyperVTimerNanosecondFactor;
   timeData.seconds      = (clock_sec_t)(hvTimeNs / NSEC_PER_SEC);
   timeData.microseconds = (hvTimeNs % NSEC_PER_SEC) / NSEC_PER_USEC;
 
-  _hvDevice->notifyUserClient(kHyperVUserClientNotificationTypeTimeSync, &timeData, sizeof (timeData));
+  _hvDevice->getHvController()->notifyUserClient(kHyperVUserClientNotificationTypeTimeSync, &timeData, sizeof (timeData));
 }
diff --git a/MacHyperVSupport/IntegrationComponents/TimeSync/HyperVTimeSync.hpp b/MacHyperVSupport/IntegrationComponents/TimeSync/HyperVTimeSync.hpp
@@ -19,9 +19,11 @@ class HyperVTimeSync : public HyperVICService {
 private:
   VMBusICVersion _timeSyncCurrentVersion = kHyperVTimeSyncVersionV1_0;
 
+ // 
+  void handleTimeAdjust(UInt64 hostTime, UInt64 referenceTime, VMBusICTimeSyncFlags flags);
+
 protected:
   void handlePacket(VMBusPacketHeader *pktHeader, UInt32 pktHeaderLength, UInt8 *pktData, UInt32 pktDataLength) APPLE_KEXT_OVERRIDE;
-  void handleTimeAdjust(UInt64 hostTime, UInt64 referenceTime, VMBusICTimeSyncFlags flags);
 
 public:
   //
diff --git a/MacHyperVSupport/Network/HyperVNetworkPrivate.cpp b/MacHyperVSupport/Network/HyperVNetworkPrivate.cpp
@@ -129,7 +129,7 @@ IOReturn HyperVNetwork::initSendReceiveBuffers() {
   //
   // Allocate receive and send buffers and create GPADLs for them.
   //
-  if (!_hvDevice->allocateDmaBuffer(&_receiveBuffer, _receiveBufferSize)) {
+  if (!_hvDevice->getHvController()->allocateDmaBuffer(&_receiveBuffer, _receiveBufferSize)) {
     HVSYSLOG("Failed to allocate receive buffer");
     freeSendReceiveBuffers();
     return kIOReturnNoResources;
@@ -139,7 +139,7 @@ IOReturn HyperVNetwork::initSendReceiveBuffers() {
     freeSendReceiveBuffers();
     return kIOReturnIOError;
   }
-  if (!_hvDevice->allocateDmaBuffer(&_sendBuffer, _sendBufferSize)) {
+  if (!_hvDevice->getHvController()->allocateDmaBuffer(&_sendBuffer, _sendBufferSize)) {
     HVSYSLOG("Failed to allocate send buffer");
     freeSendReceiveBuffers();
     return kIOReturnNoResources;
@@ -234,7 +234,7 @@ void HyperVNetwork::freeSendReceiveBuffers() {
     _hvDevice->freeGPADLBuffer(_receiveGpadlHandle);
     _receiveGpadlHandle = kHyperVGpadlNullHandle;
   }
-  _hvDevice->freeDmaBuffer(&_receiveBuffer);
+  _hvDevice->getHvController()->freeDmaBuffer(&_receiveBuffer);
 
   //
   // Release and free send buffer.
@@ -243,7 +243,7 @@ void HyperVNetwork::freeSendReceiveBuffers() {
     _hvDevice->freeGPADLBuffer(_sendGpadlHandle);
     _sendGpadlHandle = kHyperVGpadlNullHandle;
   }
-  _hvDevice->freeDmaBuffer(&_sendBuffer);
+  _hvDevice->getHvController()->freeDmaBuffer(&_sendBuffer);
 
   //
   // Free send section tracking bitmap.
diff --git a/MacHyperVSupport/Network/HyperVNetworkRNDIS.cpp b/MacHyperVSupport/Network/HyperVNetworkRNDIS.cpp
@@ -111,7 +111,7 @@ HyperVNetworkRNDISRequest* HyperVNetwork::allocateRNDISRequest(size_t additional
   //
   // Create DMA buffer with required specifications and get physical address.
   //
-  if (!_hvDevice->allocateDmaBuffer(&dmaBuffer, sizeof (HyperVNetworkRNDISRequest) + additionalLength)) {
+  if (!_hvDevice->getHvController()->allocateDmaBuffer(&dmaBuffer, sizeof (HyperVNetworkRNDISRequest) + additionalLength)) {
     HVSYSLOG("Failed to allocate buffer memory for RNDIS request");
     IOLockFree(lock);
   }
@@ -129,7 +129,7 @@ HyperVNetworkRNDISRequest* HyperVNetwork::allocateRNDISRequest(size_t additional
 
 void HyperVNetwork::freeRNDISRequest(HyperVNetworkRNDISRequest *rndisRequest) {
   IOLockFree(rndisRequest->lock);
-  _hvDevice->freeDmaBuffer(&rndisRequest->dmaBuffer);
+  _hvDevice->getHvController()->freeDmaBuffer(&rndisRequest->dmaBuffer);
 }
 
 UInt32 HyperVNetwork::getNextRNDISTransId() {
diff --git a/MacHyperVSupport/VMBus/HyperVVMBus.cpp b/MacHyperVSupport/VMBus/HyperVVMBus.cpp
@@ -464,19 +464,3 @@ void HyperVVMBus::freeVMBusChannel(UInt32 channelId) {
   HVDBGLOG("Channel %u is now freed", channelId);
   channel->status = kVMBusChannelStatusNotPresent;
 }
-
-bool HyperVVMBus::allocateDmaBuffer(HyperVDMABuffer *dmaBuf, size_t size) {
-  return hvController->allocateDmaBuffer(dmaBuf, size);
-}
-
-void HyperVVMBus::freeDmaBuffer(HyperVDMABuffer *dmaBuf) {
-  hvController->freeDmaBuffer(dmaBuf);
-}
-
-bool HyperVVMBus::checkUserClient() {
-  return hvController->checkUserClient();
-}
-
-IOReturn HyperVVMBus::notifyUserClient(HyperVUserClientNotificationType type, void *data, UInt32 dataLength) {
-  return hvController->notifyUserClient(type, data, dataLength);
-}
diff --git a/MacHyperVSupport/VMBus/HyperVVMBus.hpp b/MacHyperVSupport/VMBus/HyperVVMBus.hpp
@@ -157,10 +157,7 @@ class HyperVVMBus : public IOService {
   //
   // Misc functions.
   //
-  bool allocateDmaBuffer(HyperVDMABuffer *dmaBuf, size_t size);
-  void freeDmaBuffer(HyperVDMABuffer *dmaBuf);
-  bool checkUserClient();
-  IOReturn notifyUserClient(HyperVUserClientNotificationType type, void *data, UInt32 dataLength);
+  inline HyperVController *getHvController() { return hvController; }
   
   //
   // VMBus channel management.
diff --git a/MacHyperVSupport/VMBus/HyperVVMBusChannel.cpp b/MacHyperVSupport/VMBus/HyperVVMBusChannel.cpp
@@ -65,17 +65,17 @@ IOReturn HyperVVMBus::openVMBusChannel(UInt32 channelId, UInt32 txBufferSize, VM
   // Allocate channel ring buffers.
   // TX and RX ring buffers are allocated and provided to Hyper-V as a single large buffer.
   //
-  allocateDmaBuffer(&channel->dataBuffer, totalBufferSize);
-  allocateDmaBuffer(&channel->eventBuffer, PAGE_SIZE);
+  getHvController()->allocateDmaBuffer(&channel->dataBuffer, totalBufferSize);
+  getHvController()->allocateDmaBuffer(&channel->eventBuffer, PAGE_SIZE);
   
   //
   // Configure GPADL for channel.
   //
   status = initVMBusChannelGPADL(channelId, &channel->dataBuffer, &channel->dataGpadlHandle);
   if (status != kIOReturnSuccess) {
     HVSYSLOG("Failed to initialize GPADL for channel %u ring buffer with status 0x%X", channelId, status);
-    freeDmaBuffer(&channel->dataBuffer);
-    freeDmaBuffer(&channel->eventBuffer);
+    getHvController()->freeDmaBuffer(&channel->dataBuffer);
+    getHvController()->freeDmaBuffer(&channel->eventBuffer);
     return status;
   }
   
@@ -102,8 +102,8 @@ IOReturn HyperVVMBus::openVMBusChannel(UInt32 channelId, UInt32 txBufferSize, VM
   //
   VMBusChannelMessageChannelOpenResponse openResponseMsg;
   if (!sendVMBusMessage((VMBusChannelMessage*) &openMsg, kVMBusChannelMessageTypeChannelOpenResponse, (VMBusChannelMessage*) &openResponseMsg)) {
-    freeDmaBuffer(&channel->dataBuffer);
-    freeDmaBuffer(&channel->eventBuffer);
+    getHvController()->freeDmaBuffer(&channel->dataBuffer);
+    getHvController()->freeDmaBuffer(&channel->eventBuffer);
     return kIOReturnIOError;
   }
   HVDBGLOG("Channel %u open result: 0x%X", channelId, openResponseMsg.status);
@@ -161,8 +161,8 @@ IOReturn HyperVVMBus::closeVMBusChannel(UInt32 channelId) {
   channel->txBuffer    = nullptr;
   channel->rxBuffer    = nullptr;
   channel->rxPageIndex = 0;
-  freeDmaBuffer(&channel->dataBuffer);
-  freeDmaBuffer(&channel->eventBuffer);
+  getHvController()->freeDmaBuffer(&channel->dataBuffer);
+  getHvController()->freeDmaBuffer(&channel->eventBuffer);
   
   HVDBGLOG("Channel %u is now closed", channelId);
   return kIOReturnSuccess;
diff --git a/MacHyperVSupport/VMBus/HyperVVMBusPrivate.cpp b/MacHyperVSupport/VMBus/HyperVVMBusPrivate.cpp
@@ -13,9 +13,9 @@ bool HyperVVMBus::allocateVMBusBuffers() {
   //
   // Allocate common VMBus structures.
   //
-  allocateDmaBuffer(&vmbusEventFlags, PAGE_SIZE);
-  allocateDmaBuffer(&vmbusMnf1, PAGE_SIZE);
-  allocateDmaBuffer(&vmbusMnf2, PAGE_SIZE);
+  getHvController()->allocateDmaBuffer(&vmbusEventFlags, PAGE_SIZE);
+  getHvController()->allocateDmaBuffer(&vmbusMnf1, PAGE_SIZE);
+  getHvController()->allocateDmaBuffer(&vmbusMnf2, PAGE_SIZE);
   
   //
   // Event flag bits primarily used on Windows Server 2008 R2 and older.
diff --git a/MacHyperVSupport/VMBusDevice/HyperVVMBusDevice.cpp b/MacHyperVSupport/VMBusDevice/HyperVVMBusDevice.cpp
@@ -279,22 +279,6 @@ IOReturn HyperVVMBusDevice::freeGPADLBuffer(UInt32 gpadlHandle) {
   return _vmbusProvider->freeVMBusChannelGPADL(_channelId, gpadlHandle);
 }
 
-bool HyperVVMBusDevice::allocateDmaBuffer(HyperVDMABuffer *dmaBuf, size_t size) {
-  return _vmbusProvider->allocateDmaBuffer(dmaBuf, size);
-}
-
-void HyperVVMBusDevice::freeDmaBuffer(HyperVDMABuffer *dmaBuf) {
-  _vmbusProvider->freeDmaBuffer(dmaBuf);
-}
-
-bool HyperVVMBusDevice::checkUserClient() {
-  return _vmbusProvider->checkUserClient();
-}
-
-IOReturn HyperVVMBusDevice::notifyUserClient(HyperVUserClientNotificationType type, void *data, UInt32 dataLength) {
-  return _vmbusProvider->notifyUserClient(type, data, dataLength);
-}
-
 bool HyperVVMBusDevice::nextPacketAvailable(VMBusPacketType *type, UInt32 *packetHeaderLength, UInt32 *packetTotalLength) {
   return _commandGate->runAction(OSMemberFunctionCast(IOCommandGate::Action, this, &HyperVVMBusDevice::nextPacketAvailableGated),
                                 type, packetHeaderLength, packetTotalLength) == kIOReturnSuccess;
diff --git a/MacHyperVSupport/VMBusDevice/HyperVVMBusDevice.hpp b/MacHyperVSupport/VMBusDevice/HyperVVMBusDevice.hpp
@@ -190,11 +190,8 @@ class HyperVVMBusDevice : public IOService {
   //
   // Misc.
   //
-  void setDebugMessagePrinting(bool enabled) { debugPackets = enabled; }
-  bool allocateDmaBuffer(HyperVDMABuffer *dmaBuf, size_t size);
-  void freeDmaBuffer(HyperVDMABuffer *dmaBuf);
-  bool checkUserClient();
-  IOReturn notifyUserClient(HyperVUserClientNotificationType type, void *data, UInt32 dataLength);
+  inline void setDebugMessagePrinting(bool enabled) { debugPackets = enabled; }
+  inline HyperVController *getHvController() { return _vmbusProvider->getHvController(); }
   
   //
   // Messages.
