xref: /freebsd/share/man/man4/hv_vmbus.4 (revision b2c76c41be32f904179efed29c0ca04d53f3996c)
1fad4aec8SGlen Barber.\"
2fad4aec8SGlen Barber.\" Copyright (c) 2012 Microsoft Corp.
3fad4aec8SGlen Barber.\" All rights reserved.
4fad4aec8SGlen Barber.\"
5fad4aec8SGlen Barber.\" Redistribution and use in source and binary forms, with or without
6fad4aec8SGlen Barber.\" modification, are permitted provided that the following conditions
7fad4aec8SGlen Barber.\" are met:
8fad4aec8SGlen Barber.\" 1. Redistributions of source code must retain the above copyright
9fad4aec8SGlen Barber.\"    notice, this list of conditions and the following disclaimer.
10fad4aec8SGlen Barber.\" 2. Redistributions in binary form must reproduce the above copyright
11fad4aec8SGlen Barber.\"    notice, this list of conditions and the following disclaimer in the
12fad4aec8SGlen Barber.\"    documentation and/or other materials provided with the distribution.
13fad4aec8SGlen Barber.\"
14fad4aec8SGlen Barber.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15fad4aec8SGlen Barber.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16fad4aec8SGlen Barber.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17fad4aec8SGlen Barber.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18fad4aec8SGlen Barber.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19fad4aec8SGlen Barber.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20fad4aec8SGlen Barber.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21fad4aec8SGlen Barber.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22fad4aec8SGlen Barber.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23fad4aec8SGlen Barber.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24fad4aec8SGlen Barber.\" SUCH DAMAGE.
25fad4aec8SGlen Barber.\"
26fad4aec8SGlen Barber.Dd September 10, 2013
27fad4aec8SGlen Barber.Dt HYPER-V 4
28fad4aec8SGlen Barber.Os
29fad4aec8SGlen Barber.Sh NAME
30fad4aec8SGlen Barber.Nm hv_vmbus
31fad4aec8SGlen Barber.Nd Hyper-V Virtual Machine Bus (VMBus) Driver
32fad4aec8SGlen Barber.Sh SYNOPSIS
33fad4aec8SGlen BarberTo compile this driver into the kernel, place the following lines in
34fad4aec8SGlen Barberthe system kernel configuration file:
35fad4aec8SGlen Barber.Bd -ragged -offset indent
36fad4aec8SGlen Barber.Cd "device hyperv"
37*439b66c0SDexuan Cui.Cd "device pci"
38fad4aec8SGlen Barber.Ed
39fad4aec8SGlen Barber.Sh DESCRIPTION
40fad4aec8SGlen BarberThe
41fad4aec8SGlen Barber.Nm
42fad4aec8SGlen Barberprovides a high performance communication interface between
43fad4aec8SGlen Barberguest and root partitions in Hyper-V.
44fad4aec8SGlen BarberHyper-V is a hypervisor-based virtualization technology from Microsoft.
45fad4aec8SGlen BarberHyper-V supports isolation in terms of a partition.
46fad4aec8SGlen BarberA partition is a
47fad4aec8SGlen Barberlogical unit of isolation, supported by the hypervisor, in which
48fad4aec8SGlen Barberoperating systems execute.
49fad4aec8SGlen Barber.Pp
50fad4aec8SGlen BarberThe Microsoft hypervisor must have at least one parent, or root,
51fad4aec8SGlen Barberpartition, running Windows Server operating system.
52fad4aec8SGlen BarberThe virtualization stack runs in the parent partition and has
53fad4aec8SGlen Barberdirect access to the hardware devices.
54fad4aec8SGlen BarberThe root partition then creates the child partitions which host
55fad4aec8SGlen Barberthe guest operating systems.
56fad4aec8SGlen Barber.Pp
57fad4aec8SGlen BarberChild partitions do not have direct access to other hardware resources
58fad4aec8SGlen Barberand are presented
59fad4aec8SGlen Barbera virtual view of the resources, as virtual devices (VDevs).
60fad4aec8SGlen BarberRequests to the virtual devices are
61fad4aec8SGlen Barberredirected either via the VMBus or the hypervisor to the devices in
62fad4aec8SGlen Barberthe parent partition, which handles the requests.
63fad4aec8SGlen Barber.Pp
64fad4aec8SGlen BarberThe VMBus is a logical inter-partition communication channel.
65fad4aec8SGlen BarberThe parent partition hosts Virtualization Service Providers (VSPs)
66fad4aec8SGlen Barberwhich communicate over the VMBus to handle device access requests from
67fad4aec8SGlen Barberchild partitions.
68fad4aec8SGlen BarberChild partitions host Virtualization Service
69fad4aec8SGlen BarberConsumers (VSCs) which redirect device requests to VSPs in the parent
70fad4aec8SGlen Barberpartition via the VMBus.
71fad4aec8SGlen BarberThe Hyper-V VMBus driver defines and implements
72fad4aec8SGlen Barberthe interface that facilitate high performance bi-directional communication
73fad4aec8SGlen Barberbetween the VSCs and VSPs.
74fad4aec8SGlen BarberAll VSCs utilize the VMBus driver.
75fad4aec8SGlen Barber.Sh SEE ALSO
76fad4aec8SGlen Barber.Xr hv_netvsc 4 ,
77fad4aec8SGlen Barber.Xr hv_storvsc 4 ,
78923544aaSBaptiste Daroussin.Xr hv_utils 4
79fad4aec8SGlen Barber.Sh HISTORY
80fad4aec8SGlen BarberSupport for
81fad4aec8SGlen Barber.Nm
82fad4aec8SGlen Barberfirst appeared in
83fad4aec8SGlen Barber.Fx 10.0 .
84fad4aec8SGlen BarberThe driver was developed through a joint effort between Citrix Incorporated,
85fad4aec8SGlen BarberMicrosoft Corporation, and Network Appliance Incorporated.
86fad4aec8SGlen Barber.Sh AUTHORS
87fad4aec8SGlen Barber.An -nosplit
88fad4aec8SGlen Barber.Fx
89fad4aec8SGlen Barbersupport for
90fad4aec8SGlen Barber.Nm
91fad4aec8SGlen Barberwas first added by
926c899950SBaptiste Daroussin.An Microsoft BSD Integration Services Team Aq Mt bsdic@microsoft.com .
93