vmbus_server: move SINT constant to vmbus_core (#2340)

This change moves the `SINT` constant to the `vmbus_core` crate, so it
can be used in other places. It also renames it to `VMBUS_SINT` for
clarity.

Author: SvenGroot

vm/devices/vmbus/vmbus_core/src/lib.rs

@@ -22,6 +22,9 @@ use zerocopy::Immutable;
 use zerocopy::IntoBytes;
 use zerocopy::KnownLayout;
 
+/// The standard, non-redirected synthetic interrupt used by VMBus.
+pub const VMBUS_SINT: u8 = 2;
+
 #[derive(Debug)]
 pub struct TaggedStream<T, S>(Option<T>, S);
 

vm/devices/vmbus/vmbus_server/src/channels.rs

@@ -6,7 +6,6 @@ pub mod saved_state;
 mod tests;
 
 use crate::Guid;
-use crate::SINT;
 use crate::SynicMessage;
 use crate::monitor::AssignedMonitors;
 use crate::protocol::Version;
@@ -37,6 +36,7 @@ use vmbus_core::HvsockConnectRequest;
 use vmbus_core::HvsockConnectResult;
 use vmbus_core::MaxVersionInfo;
 use vmbus_core::OutgoingMessage;
+use vmbus_core::VMBUS_SINT;
 use vmbus_core::VersionInfo;
 use vmbus_core::protocol;
 use vmbus_core::protocol::ChannelId;
@@ -867,7 +867,7 @@ impl Channel {
 
         let channel_id = entry.id();
         entry.insert(offer_id);
-        let connection_id = ConnectionId::new(channel_id.0, assigned_channels.vtl, SINT);
+        let connection_id = ConnectionId::new(channel_id.0, assigned_channels.vtl, VMBUS_SINT);
 
         // Allocate a monitor ID if the channel uses MNF.
         // N.B. If the synic doesn't support MNF or MNF is disabled by the server, use_mnf should
@@ -2111,7 +2111,7 @@ impl<'a, N: 'a + Notifier> ServerWithNotifier<'a, N> {
         {
             target_info.sint()
         } else {
-            SINT
+            VMBUS_SINT
         };
 
         let target_vtl = if message.multiclient
@@ -2205,7 +2205,7 @@ impl<'a, N: 'a + Notifier> ServerWithNotifier<'a, N> {
             return;
         }
 
-        if request.target_sint != SINT {
+        if request.target_sint != VMBUS_SINT {
             tracelimit::warn_ratelimited!(
                 target_vtl = request.target_vtl,
                 target_sint = request.target_sint,

vm/devices/vmbus/vmbus_server/src/channels/tests.rs

@@ -88,7 +88,7 @@ fn test_version_negotiation_multiclient_vtl() {
     let mut env = TestEnv::new();
 
     let target_info = TargetInfo::new()
-        .with_sint(SINT)
+        .with_sint(VMBUS_SINT)
         .with_vtl(2)
         .with_feature_flags(FeatureFlags::new().into());
 
@@ -133,7 +133,7 @@ fn test_version_negotiation_feature_flags() {
 
     // Test with no feature flags.
     let mut target_info = TargetInfo::new()
-        .with_sint(SINT)
+        .with_sint(VMBUS_SINT)
         .with_vtl(0)
         .with_feature_flags(FeatureFlags::new().into());
     test_initiate_contact(
@@ -399,7 +399,7 @@ fn test_channel_lifetime_helper(version: Version, feature_flags: FeatureFlags) {
         .unwrap();
 
     let mut target_info = TargetInfo::new()
-        .with_sint(SINT)
+        .with_sint(VMBUS_SINT)
         .with_vtl(2)
         .with_feature_flags(FeatureFlags::new().into());
     if version >= Version::Copper {
@@ -788,12 +788,12 @@ fn test_save_restore_with_connection() {
     env.gpadl(3, 31);
 
     // Test Opening, Open, and Closing save for reserved channels
-    env.open_reserved(7, 1, SINT.into());
-    env.open_reserved(8, 2, SINT.into());
-    env.open_reserved(9, 3, SINT.into());
+    env.open_reserved(7, 1, VMBUS_SINT.into());
+    env.open_reserved(8, 2, VMBUS_SINT.into());
+    env.open_reserved(9, 3, VMBUS_SINT.into());
     env.c().open_complete(offer_id8, 0);
     env.c().open_complete(offer_id9, 0);
-    env.close_reserved(9, 3, SINT.into());
+    env.close_reserved(9, 3, VMBUS_SINT.into());
 
     // Revoke an offer but don't have the "guest" release it, so we can then mark it as
     // reoffered.
@@ -853,7 +853,7 @@ fn test_save_restore_with_connection() {
 
     // Check reserved channels have been restored to the same state
     env.c().open_complete(offer_id7, 0);
-    env.close_reserved(8, 2, SINT.into());
+    env.close_reserved(8, 2, VMBUS_SINT.into());
     env.c().close_complete(offer_id8);
     env.c().close_complete(offer_id9);
 
@@ -1146,7 +1146,7 @@ fn test_pending_messages() {
 
     env.notifier.messages.clear();
     env.notifier.pend_messages = true;
-    env.open_reserved(2, 4, SINT.into());
+    env.open_reserved(2, 4, VMBUS_SINT.into());
     env.c().open_complete(offer_id2, protocol::STATUS_SUCCESS);
 
     // Reserved channel message should not be queued, but just discarded if it cannot be sent.
@@ -1297,18 +1297,24 @@ fn test_reserved_channels() {
     env.notifier.messages.clear();
 
     // Open responses should be sent to the provided target
-    env.open_reserved(1, 1, SINT.into());
+    env.open_reserved(1, 1, VMBUS_SINT.into());
     env.c().open_complete(offer_id1, 0);
     env.notifier.check_message_with_target(
         OutgoingMessage::new(&protocol::OpenResult {
             channel_id: ChannelId(1),
             ..FromZeros::new_zeroed()
         }),
-        MessageTarget::ReservedChannel(offer_id1, ConnectionTarget { vp: 1, sint: SINT }),
+        MessageTarget::ReservedChannel(
+            offer_id1,
+            ConnectionTarget {
+                vp: 1,
+                sint: VMBUS_SINT,
+            },
+        ),
     );
-    env.open_reserved(2, 2, SINT.into());
+    env.open_reserved(2, 2, VMBUS_SINT.into());
     env.c().open_complete(offer_id2, 0);
-    env.open_reserved(3, 3, SINT.into());
+    env.open_reserved(3, 3, VMBUS_SINT.into());
     env.c().open_complete(offer_id3, 0);
 
     // This should fail
@@ -1319,7 +1325,7 @@ fn test_reserved_channels() {
     env.complete_reset();
 
     // Closing while disconnected should work
-    env.close_reserved(2, 2, SINT.into());
+    env.close_reserved(2, 2, VMBUS_SINT.into());
     env.c().close_complete(offer_id2);
 
     env.notifier.messages.clear();
@@ -1332,20 +1338,26 @@ fn test_reserved_channels() {
     env.c().gpadl_create_complete(offer_id2, GpadlId(10), 0);
 
     // Reopening the same offer should work
-    env.open_reserved(2, 3, SINT.into());
+    env.open_reserved(2, 3, VMBUS_SINT.into());
     env.c().open_complete(offer_id2, 0);
 
     env.notifier.messages.clear();
 
     // The channel should still be open after disconnect/reconnect
     // and close responses should be sent to the provided target
-    env.close_reserved(1, 4, SINT.into());
+    env.close_reserved(1, 4, VMBUS_SINT.into());
     env.c().close_complete(offer_id1);
     env.notifier.check_message_with_target(
         OutgoingMessage::new(&protocol::CloseReservedChannelResponse {
             channel_id: ChannelId(1),
         }),
-        MessageTarget::ReservedChannel(offer_id1, ConnectionTarget { vp: 4, sint: SINT }),
+        MessageTarget::ReservedChannel(
+            offer_id1,
+            ConnectionTarget {
+                vp: 4,
+                sint: VMBUS_SINT,
+            },
+        ),
     );
     env.teardown_gpadl(1, 10);
     env.c().gpadl_teardown_complete(offer_id1, GpadlId(10));
@@ -1371,7 +1383,7 @@ fn test_disconnected_reset() {
 
     env.gpadl(1, 10);
     env.c().gpadl_create_complete(offer_id1, GpadlId(10), 0);
-    env.open_reserved(1, 1, SINT.into());
+    env.open_reserved(1, 1, VMBUS_SINT.into());
     env.c().open_complete(offer_id1, 0);
 
     env.c().handle_unload();
@@ -1394,13 +1406,13 @@ fn test_disconnected_reset() {
 
     env.gpadl(2, 20);
     env.c().gpadl_create_complete(offer_id2, GpadlId(20), 0);
-    env.open_reserved(2, 2, SINT.into());
+    env.open_reserved(2, 2, VMBUS_SINT.into());
     env.c().open_complete(offer_id2, 0);
 
     env.c().handle_unload();
     env.complete_reset();
 
-    env.close_reserved(2, 2, SINT.into());
+    env.close_reserved(2, 2, VMBUS_SINT.into());
     env.c().close_complete(offer_id2);
     env.c().gpadl_teardown_complete(offer_id2, GpadlId(20));
 
@@ -1511,7 +1523,7 @@ fn test_server_monitor_page_helper(provide_guest_pages: bool) {
             protocol::InitiateContact {
                 version_requested: version as u32,
                 interrupt_page_or_target_info: TargetInfo::new()
-                    .with_sint(SINT)
+                    .with_sint(VMBUS_SINT)
                     .with_vtl(0)
                     .with_feature_flags(feature_flags.into())
                     .into(),
@@ -1998,7 +2010,10 @@ fn test_reinitiate_contact() {
         protocol::MessageType::INITIATE_CONTACT,
         protocol::InitiateContact {
             version_requested: Version::Win10 as u32,
-            interrupt_page_or_target_info: TargetInfo::new().with_sint(SINT).with_vtl(0).into(),
+            interrupt_page_or_target_info: TargetInfo::new()
+                .with_sint(VMBUS_SINT)
+                .with_vtl(0)
+                .into(),
             child_to_parent_monitor_page_gpa: 0x123f000,
             parent_to_child_monitor_page_gpa: 0x321f000,
             ..FromZeros::new_zeroed()
@@ -2500,7 +2515,7 @@ impl TestEnv {
                 initiate_contact: protocol::InitiateContact {
                     version_requested: version as u32,
                     interrupt_page_or_target_info: TargetInfo::new()
-                        .with_sint(SINT)
+                        .with_sint(VMBUS_SINT)
                         .with_vtl(0)
                         .with_feature_flags(feature_flags.into())
                         .into(),

vm/devices/vmbus/vmbus_server/src/lib.rs

@@ -83,6 +83,7 @@ use vmbus_core::HvsockConnectResult;
 use vmbus_core::MaxVersionInfo;
 use vmbus_core::OutgoingMessage;
 use vmbus_core::TaggedStream;
+use vmbus_core::VMBUS_SINT;
 use vmbus_core::VersionInfo;
 use vmbus_core::protocol;
 pub use vmbus_core::protocol::GpadlId;
@@ -99,7 +100,6 @@ use vmcore::synic::MessagePort;
 use vmcore::synic::MonitorPageGpas;
 use vmcore::synic::SynicPortAccess;
 
-const SINT: u8 = 2;
 pub const REDIRECT_SINT: u8 = 7;
 pub const REDIRECT_VTL: Vtl = Vtl::Vtl2;
 const SHARED_EVENT_CONNECTION_ID: u32 = 2;
@@ -463,7 +463,7 @@ impl<T: SpawnDriver + Clone> VmbusServerBuilder<T> {
         let (redirect_vtl, redirect_sint) = if self.use_message_redirect {
             (REDIRECT_VTL, REDIRECT_SINT)
         } else {
-            (self.vtl, SINT)
+            (self.vtl, VMBUS_SINT)
         };
 
         // If this server is not for VTL2, use a server-specific connection ID rather than the
@@ -1792,11 +1792,11 @@ impl ServerTaskInner {
         let (target_vtl, target_sint) = if open_params.flags.redirect_interrupt() {
             (self.redirect_vtl, self.redirect_sint)
         } else {
-            (self.vtl, SINT)
+            (self.vtl, VMBUS_SINT)
         };
 
         let guest_event_port = self.synic.new_guest_event_port(
-            VmbusServer::get_child_event_port_id(open_params.channel_id, SINT, self.vtl),
+            VmbusServer::get_child_event_port_id(open_params.channel_id, VMBUS_SINT, self.vtl),
             target_vtl,
             target_vp,
             target_sint,