Struct VmbusServerBuilder

pub struct VmbusServerBuilder<'a, T: Spawn> { /* private fields */ }

Implementations

impl<'a, T: Spawn> VmbusServerBuilder<'a, T>

pub fn new( spawner: &'a T, synic: Arc<dyn SynicPortAccess>, gm: GuestMemory, ) -> Self

Creates a new builder for VmbusServer with the default options.

pub fn private_gm(self, private_gm: Option<GuestMemory>) -> Self

Sets a separate guest memory instance to use for channels that are confidential (non-relay channels in Underhill on a hardware isolated VM). This is not relevant for a non-Underhill VmBus server.

pub fn vtl(self, vtl: Vtl) -> Self

Sets the VTL that this instance will serve.

pub fn hvsock_notify( self, hvsock_notify: Option<HvsockServerChannelHalf>, ) -> Self

Sets a send/receive pair used to handle hvsocket requests.

pub fn server_relay(self, server_relay: Option<VmbusServerChannelHalf>) -> Self

Sets a send/receive pair that will be notified of server requests. This is used by the Underhill relay.

pub fn external_requests( self, external_requests: Option<Receiver<InitiateContactRequest>>, ) -> Self

Sets a receiver that receives requests from another server.

pub fn external_server( self, external_server: Option<Sender<InitiateContactRequest>>, ) -> Self

Sets a sender used to forward unhandled connect requests (which used a different VTL) to another server.

pub fn use_message_redirect(self, use_message_redirect: bool) -> Self

Sets a value which indicates whether the vmbus control plane is redirected to Underhill.

pub fn enable_channel_id_offset(self, enable: bool) -> Self

Tells the server to use an offset when generating channel IDs to void collisions with another vmbus server.

N.B. This should only be used by the Underhill vmbus server.

pub fn max_version(self, max_version: Option<MaxVersionInfo>) -> Self

Tells the server to limit the protocol version offered to the guest.

N.B. This is used for testing older protocols without requiring a specific guest OS.

pub fn delay_max_version(self, delay: bool) -> Self

Delay limiting the maximum version until after the first Unload message.

N.B. This is used to enable the use of versions older than Version::Win10 with Uefi boot, since that’s the oldest version the Uefi client supports.

pub fn enable_mnf(self, enable: bool) -> Self

Enable MNF support in the server.

N.B. Enabling this has no effect if the synic does not support mapping monitor pages.

pub fn force_confidential_external_memory(self, force: bool) -> Self

Force all non-relay channels to use encrypted external memory. Used for testing purposes only.

pub fn send_messages_while_stopped(self, send: bool) -> Self

Send messages to the partition even while stopped, which can cause corrupted synic states across VM reset.

This option is used to prevent messages from getting into the queue, for saved state compatibility with release/2411. It can be removed once that release is no longer supported.

pub fn build(self) -> Result<VmbusServer>

Creates a new instance of the server.

When the object is dropped, all channels will be closed and revoked automatically.